Commit 26a45889 authored by Jonston Chan's avatar Jonston Chan

Make the examples consistently use "<your_access_token>"

parent 8c5b7e92
...@@ -73,7 +73,7 @@ POST /import/bitbucket_server ...@@ -73,7 +73,7 @@ POST /import/bitbucket_server
curl --request POST \ curl --request POST \
--url "https://gitlab.example.com/api/v4/import/bitbucket_server" \ --url "https://gitlab.example.com/api/v4/import/bitbucket_server" \
--header "content-type: application/json" \ --header "content-type: application/json" \
--header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" \ --header "PRIVATE-TOKEN: <your_access_token>" \
--data '{ --data '{
"bitbucket_server_url": "http://bitbucket.example.com", "bitbucket_server_url": "http://bitbucket.example.com",
"bitbucket_server_username": "root", "bitbucket_server_username": "root",
......
...@@ -398,7 +398,7 @@ POST /groups/:id/members/:user_id/override ...@@ -398,7 +398,7 @@ POST /groups/:id/members/:user_id/override
| `user_id` | integer | yes | The user ID of the member | | `user_id` | integer | yes | The user ID of the member |
```shell ```shell
curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/groups/:id/members/:user_id/override" curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members/:user_id/override"
``` ```
Example response: Example response:
...@@ -435,7 +435,7 @@ DELETE /groups/:id/members/:user_id/override ...@@ -435,7 +435,7 @@ DELETE /groups/:id/members/:user_id/override
| `user_id` | integer | yes | The user ID of the member | | `user_id` | integer | yes | The user ID of the member |
```shell ```shell
curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/groups/:id/members/:user_id/override" curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members/:user_id/override"
``` ```
Example response: Example response:
......
...@@ -28,7 +28,7 @@ GET /projects/:id/releases ...@@ -28,7 +28,7 @@ GET /projects/:id/releases
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: gDybLx3yrUK_HLp3qPjS" "https://gitlab.example.com/api/v4/projects/24/releases" curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/24/releases"
``` ```
Example response: Example response:
...@@ -233,7 +233,7 @@ GET /projects/:id/releases/:tag_name ...@@ -233,7 +233,7 @@ GET /projects/:id/releases/:tag_name
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: gDybLx3yrUK_HLp3qPjS" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1" curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1"
``` ```
Example response: Example response:
...@@ -374,7 +374,7 @@ POST /projects/:id/releases ...@@ -374,7 +374,7 @@ POST /projects/:id/releases
Example request: Example request:
```shell ```shell
curl --header 'Content-Type: application/json' --header "PRIVATE-TOKEN: gDybLx3yrUK_HLp3qPjS" \ curl --header 'Content-Type: application/json' --header "PRIVATE-TOKEN: <your_access_token>" \
--data '{ "name": "New release", "tag_name": "v0.3", "description": "Super nice release", "milestones": ["v1.0", "v1.0-rc"], "assets": { "links": [{ "name": "hoge", "url": "https://google.com", "filepath": "/binaries/linux-amd64", "link_type":"other" }] } }' \ --data '{ "name": "New release", "tag_name": "v0.3", "description": "Super nice release", "milestones": ["v1.0", "v1.0-rc"], "assets": { "links": [{ "name": "hoge", "url": "https://google.com", "filepath": "/binaries/linux-amd64", "link_type":"other" }] } }' \
--request POST "https://gitlab.example.com/api/v4/projects/24/releases" --request POST "https://gitlab.example.com/api/v4/projects/24/releases"
``` ```
...@@ -513,7 +513,7 @@ POST /projects/:id/releases/:tag_name/evidence ...@@ -513,7 +513,7 @@ POST /projects/:id/releases/:tag_name/evidence
Example request: Example request:
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: gDybLx3yrUK_HLp3qPjS" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/evidence" curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/evidence"
``` ```
Example response: Example response:
...@@ -542,7 +542,7 @@ PUT /projects/:id/releases/:tag_name ...@@ -542,7 +542,7 @@ PUT /projects/:id/releases/:tag_name
Example request: Example request:
```shell ```shell
curl --header 'Content-Type: application/json' --request PUT --data '{"name": "new name", "milestones": ["v1.2"]}' --header "PRIVATE-TOKEN: gDybLx3yrUK_HLp3qPjS" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1" curl --header 'Content-Type: application/json' --request PUT --data '{"name": "new name", "milestones": ["v1.2"]}' --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1"
``` ```
Example response: Example response:
...@@ -645,7 +645,7 @@ DELETE /projects/:id/releases/:tag_name ...@@ -645,7 +645,7 @@ DELETE /projects/:id/releases/:tag_name
Example request: Example request:
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: gDybLx3yrUK_HLp3qPjS" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1" curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1"
``` ```
Example response: Example response:
......
...@@ -27,7 +27,7 @@ GET /projects/:id/releases/:tag_name/assets/links ...@@ -27,7 +27,7 @@ GET /projects/:id/releases/:tag_name/assets/links
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: n671WNGecHugsdEDPsyo" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links" curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links"
``` ```
Example response: Example response:
...@@ -68,7 +68,7 @@ GET /projects/:id/releases/:tag_name/assets/links/:link_id ...@@ -68,7 +68,7 @@ GET /projects/:id/releases/:tag_name/assets/links/:link_id
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: n671WNGecHugsdEDPsyo" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links/1" curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links/1"
``` ```
Example response: Example response:
...@@ -104,7 +104,7 @@ Example request: ...@@ -104,7 +104,7 @@ Example request:
```shell ```shell
curl --request POST \ curl --request POST \
--header "PRIVATE-TOKEN: tkhfG7HgG-LiZd3zfdDC" \ --header "PRIVATE-TOKEN: <your_access_token>" \
--data name="hellodarwin-amd64" \ --data name="hellodarwin-amd64" \
--data url="https://gitlab.example.com/mynamespace/hello/-/jobs/688/artifacts/raw/bin/hello-darwin-amd64" \ --data url="https://gitlab.example.com/mynamespace/hello/-/jobs/688/artifacts/raw/bin/hello-darwin-amd64" \
--data filepath="/bin/hellodarwin-amd64" \ --data filepath="/bin/hellodarwin-amd64" \
...@@ -148,7 +148,7 @@ You have to specify at least one of `name` or `url` ...@@ -148,7 +148,7 @@ You have to specify at least one of `name` or `url`
Example request: Example request:
```shell ```shell
curl --request PUT --data name="new name" --data link_type="runbook" --header "PRIVATE-TOKEN: n671WNGecHugsdEDPsyo" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links/1" curl --request PUT --data name="new name" --data link_type="runbook" --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links/1"
``` ```
Example response: Example response:
...@@ -180,7 +180,7 @@ DELETE /projects/:id/releases/:tag_name/assets/links/:link_id ...@@ -180,7 +180,7 @@ DELETE /projects/:id/releases/:tag_name/assets/links/:link_id
Example request: Example request:
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: n671WNGecHugsdEDPsyo" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links/1" curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links/1"
``` ```
Example response: Example response:
......
...@@ -79,7 +79,7 @@ Alternatively, you can use the API to protect an environment: ...@@ -79,7 +79,7 @@ Alternatively, you can use the API to protect an environment:
1. Use the API to add a user to the group as a reporter: 1. Use the API to add a user to the group as a reporter:
```shell ```shell
$ curl --request POST --header "PRIVATE-TOKEN: xxxxxxxxxxxx" --data "user_id=3222377&access_level=20" "https://gitlab.com/api/v4/groups/9899826/members" $ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "user_id=3222377&access_level=20" "https://gitlab.com/api/v4/groups/9899826/members"
{"id":3222377,"name":"Sean Carroll","username":"sfcarroll","state":"active","avatar_url":"https://assets.gitlab-static.net/uploads/-/system/user/avatar/3222377/avatar.png","web_url":"https://gitlab.com/sfcarroll","access_level":20,"created_at":"2020-10-26T17:37:50.309Z","expires_at":null} {"id":3222377,"name":"Sean Carroll","username":"sfcarroll","state":"active","avatar_url":"https://assets.gitlab-static.net/uploads/-/system/user/avatar/3222377/avatar.png","web_url":"https://gitlab.com/sfcarroll","access_level":20,"created_at":"2020-10-26T17:37:50.309Z","expires_at":null}
``` ```
...@@ -87,7 +87,7 @@ Alternatively, you can use the API to protect an environment: ...@@ -87,7 +87,7 @@ Alternatively, you can use the API to protect an environment:
1. Use the API to add the group to the project as a reporter: 1. Use the API to add the group to the project as a reporter:
```shell ```shell
$ curl --request POST --header "PRIVATE-TOKEN: xxxxxxxxxxxx" --request POST "https://gitlab.com/api/v4/projects/22034114/share?group_id=9899826&group_access=20" $ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --request POST "https://gitlab.com/api/v4/projects/22034114/share?group_id=9899826&group_access=20"
{"id":1233335,"project_id":22034114,"group_id":9899826,"group_access":20,"expires_at":null} {"id":1233335,"project_id":22034114,"group_id":9899826,"group_access":20,"expires_at":null}
``` ```
...@@ -95,7 +95,7 @@ Alternatively, you can use the API to protect an environment: ...@@ -95,7 +95,7 @@ Alternatively, you can use the API to protect an environment:
1. Use the API to add the group with protected environment access: 1. Use the API to add the group with protected environment access:
```shell ```shell
curl --header 'Content-Type: application/json' --request POST --data '{"name": "production", "deploy_access_levels": [{"group_id": 9899826}]}' --header "PRIVATE-TOKEN: xxxxxxxxxxx" "https://gitlab.com/api/v4/projects/22034114/protected_environments" curl --header 'Content-Type: application/json' --request POST --data '{"name": "production", "deploy_access_levels": [{"group_id": 9899826}]}' --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.com/api/v4/projects/22034114/protected_environments"
``` ```
The group now has access and can be seen in the UI. The group now has access and can be seen in the UI.
......
...@@ -512,8 +512,7 @@ You can use these fake tokens as examples: ...@@ -512,8 +512,7 @@ You can use these fake tokens as examples:
| Token type | Token value | | Token type | Token value |
|:----------------------|:-------------------------------------------------------------------| |:----------------------|:-------------------------------------------------------------------|
| Private user token | `<your_access_token>` | | Personal access token | `<your_access_token>` |
| Personal access token | `n671WNGecHugsdEDPsyo` |
| Application ID | `2fcb195768c39e9a94cec2c2e32c59c0aad7a3365c10892e8116b5d83d4096b6` | | Application ID | `2fcb195768c39e9a94cec2c2e32c59c0aad7a3365c10892e8116b5d83d4096b6` |
| Application secret | `04f294d1eaca42b8692017b426d53bbc8fe75f827734f0260710b83a556082df` | | Application secret | `04f294d1eaca42b8692017b426d53bbc8fe75f827734f0260710b83a556082df` |
| CI/CD variable | `Li8j-mLUVA3eZYjPfd_H` | | CI/CD variable | `Li8j-mLUVA3eZYjPfd_H` |
......
...@@ -103,7 +103,7 @@ the components outlined above and the pre-loaded demo runbook. ...@@ -103,7 +103,7 @@ the components outlined above and the pre-loaded demo runbook.
Enter these values, maintaining the single quotes as follows: Enter these values, maintaining the single quotes as follows:
```sql ```sql
PRIVATE_TOKEN = 'n671WNGecHugsdEDPsyo' PRIVATE_TOKEN = '<your_access_token>'
PROJECT_ID = '1234567' PROJECT_ID = '1234567'
``` ```
......
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