diff options
| author | Patrick Bajao <ebajao@gitlab.com> | 2019-06-17 11:56:59 +0800 |
|---|---|---|
| committer | Patrick Bajao <ebajao@gitlab.com> | 2019-06-26 10:10:11 +0800 |
| commit | 6aa0b173e240f7f27c2cc6d1d4c87b7688940283 (patch) | |
| tree | c58fc49cbc9dbf806a975be3fd813f101d73cb0e /doc/api | |
| parent | 550ac52b143b7d4b77203b81c1b92997c4c63e34 (diff) | |
| download | gitlab-ce-6aa0b173e240f7f27c2cc6d1d4c87b7688940283.tar.gz | |
Update related documentation
Update the newly added documentation to be more precise and
fix the typos.
Add information about Project aliases into permissions doc.
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/project_aliases.md | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/doc/api/project_aliases.md b/doc/api/project_aliases.md index 4456388c74f..20e4e844654 100644 --- a/doc/api/project_aliases.md +++ b/doc/api/project_aliases.md @@ -1,10 +1,12 @@ -# Project Aliases API +# Project Aliases API **[PREMIUM ONLY]** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/3264) in GitLab 12.1. All methods require administrator authorization. ## List all project aliases -Get a list of all project aliases +Get a list of all project aliases: ``` GET /project_aliases @@ -33,7 +35,7 @@ Example response: ## Get project alias' details -Get details of a project alias +Get details of a project alias: ``` GET /project_aliases/:name @@ -57,9 +59,10 @@ Example response: } ``` -## Create an alias for a project +## Create a project alias -Add a new alias for a project. Reponds with a 201 when successful, 400 when there are validation errors (e.g. alias already exists). +Add a new alias for a project. Responds with a 201 when successful, +400 when there are validation errors (e.g. alias already exists): ``` POST /project_aliases @@ -67,7 +70,7 @@ POST /project_aliases | Attribute | Type | Required | Description | |--------------|--------|----------|-----------------------------------------------| -| `project_id` | string | yes | The The ID or URL-encoded path of the project | +| `project_id` | string | yes | The ID or URL-encoded path of the project. | | `name` | string | yes | The name of the alias. Must be unique. | ``` @@ -84,9 +87,10 @@ Example response: } ``` -## Delete a project aliase +## Delete a project alias -Removes a project aliases. Respond with a 204 when project alias exists, 404 when it doesn't. +Removes a project aliases. Responds with a 204 when project alias +exists, 404 when it doesn't: ``` DELETE /project_aliases/:name |