diff options
Diffstat (limited to 'doc/api/README.md')
| -rw-r--r-- | doc/api/README.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index ef3b578f04e..30e1f1ed79c 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -335,7 +335,7 @@ resources you can pass the following parameters: In the example below, we list 50 [namespaces](namespaces.md) per page. -```bash +```shell curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/namespaces?per_page=50" ``` @@ -349,7 +349,7 @@ In the cURL example below, we limit the output to 3 items per page (`per_page=3` and we request the second page (`page=2`) of [comments](notes.md) of the issue with ID `8` which belongs to the project with ID `8`: -```bash +```shell curl --head --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/8/issues/8/notes?per_page=3&page=2 ``` @@ -409,7 +409,7 @@ This method is controlled by the following parameters: In the example below, we list 50 [projects](projects.md) per page, ordered by `id` ascending. -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects?pagination=keyset&per_page=50&order_by=id&sort=asc" ``` @@ -472,7 +472,7 @@ We can call the API with `array` and `hash` types parameters as shown below: `import_sources` is a parameter of type `array`: -```bash +```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \ -d "import_sources[]=github" \ -d "import_sources[]=bitbucket" \ @@ -483,7 +483,7 @@ https://gitlab.example.com/api/v4/some_endpoint `override_params` is a parameter of type `hash`: -```bash +```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \ --form "namespace=email" \ --form "path=impapi" \ @@ -497,7 +497,7 @@ https://gitlab.example.com/api/v4/projects/import `variables` is a parameter of type `array` containing hash key/value pairs `[{ 'key' => 'UPLOAD_TO_S3', 'value' => 'true' }]`: -```bash +```shell curl --globoff --request POST --header "PRIVATE-TOKEN: ********************" \ "https://gitlab.example.com/api/v4/projects/169/pipeline?ref=master&variables[][key]=VAR1&variables[][value]=hello&variables[][key]=VAR2&variables[][value]=world" |