Commit edf1945f authored by Athar Hameed's avatar Athar Hameed

Add examples for array and hash type API params

parent ba38931d
...@@ -388,7 +388,7 @@ For example, `/` is represented by `%2F`: ...@@ -388,7 +388,7 @@ For example, `/` is represented by `%2F`:
GET /api/v4/projects/diaspora%2Fdiaspora GET /api/v4/projects/diaspora%2Fdiaspora
``` ```
## Branches & tags name encoding ## Branches and tags name encoding
If your branch or tag contains a `/`, make sure the branch/tag name is If your branch or tag contains a `/`, make sure the branch/tag name is
URL-encoded. URL-encoded.
...@@ -399,6 +399,36 @@ For example, `/` is represented by `%2F`: ...@@ -399,6 +399,36 @@ For example, `/` is represented by `%2F`:
GET /api/v4/projects/1/branches/my%2Fbranch/commits GET /api/v4/projects/1/branches/my%2Fbranch/commits
``` ```
## Encoding API parameters of `array` and `hash` types
When making an API call with parameters of type `array` and/or `hash`, the parameters may be
specified as shown below.
### `array`
`import_sources` is a parameter of type `array`:
```
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" \
-d "import_sources[]=github" \
-d "import_sources[]=bitbucket" \
"https://gitlab.example.com/api/v4/some_endpoint
```
### `hash`
`override_params` is a parameter of type `hash`:
```
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" \
--form "namespace=email" \
--form "path=impapi" \
--form "file=@/path/to/somefile.txt"
--form "override_params[visibility]=private" \
--form "override_params[some_other_param]=some_value" \
https://gitlab.example.com/api/v4/projects/import
```
## `id` vs `iid` ## `id` vs `iid`
When you work with the API, you may notice two similar fields in API entities: When you work with the API, you may notice two similar fields in API entities:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment