diff options
| author | Patrick Bajao <ebajao@gitlab.com> | 2019-07-03 14:55:29 +0800 |
|---|---|---|
| committer | Patrick Bajao <ebajao@gitlab.com> | 2019-07-03 14:55:33 +0800 |
| commit | 96f9f86c92d6e6db9f51762fa09efa1159610bd8 (patch) | |
| tree | c12248740dc934b3dc34b86307e7e265635f6cde | |
| parent | c1d250c2844991f51489d769dd6fca0f4ebdda19 (diff) | |
| download | gitlab-ce-3264-update-project-aliases-api-docs.tar.gz | |
Update Project Aliases API documentation3264-update-project-aliases-api-docs
Fix the example for POST /project_aliases since it doesn't need
the project_id to be URL encoded.
| -rw-r--r-- | doc/api/project_aliases.md | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/doc/api/project_aliases.md b/doc/api/project_aliases.md index 65845579409..76343b4cd82 100644 --- a/doc/api/project_aliases.md +++ b/doc/api/project_aliases.md @@ -68,13 +68,19 @@ Add a new alias for a project. Responds with a 201 when successful, POST /project_aliases ``` -| Attribute | Type | Required | Description | -|--------------|--------|----------|-----------------------------------------------| -| `project_id` | string | yes | The ID or URL-encoded path of the project. | -| `name` | string | yes | The name of the alias. Must be unique. | +| Attribute | Type | Required | Description | +|--------------|----------------|----------|----------------------------------------| +| `project_id` | integer/string | yes | The ID or path of the project. | +| `name` | string | yes | The name of the alias. Must be unique. | ``` -curl --request POST "https://gitlab.example.com/api/v4/project_aliases" --form "project_id=gitlab-org%2Fgitlab-ee" --form "name=gitlab-ee" +curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/project_aliases" --form "project_id=1" --form "name=gitlab-ee" +``` + +or + +``` +curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/project_aliases" --form "project_id=gitlab-org/gitlab-ee" --form "name=gitlab-ee" ``` Example response: |