From 96f9f86c92d6e6db9f51762fa09efa1159610bd8 Mon Sep 17 00:00:00 2001 From: Patrick Bajao Date: Wed, 3 Jul 2019 14:55:29 +0800 Subject: Update Project Aliases API documentation Fix the example for POST /project_aliases since it doesn't need the project_id to be URL encoded. --- doc/api/project_aliases.md | 16 +++++++++++----- 1 file 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: " "https://gitlab.example.com/api/v4/project_aliases" --form "project_id=1" --form "name=gitlab-ee" +``` + +or + +``` +curl --request POST --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/project_aliases" --form "project_id=gitlab-org/gitlab-ee" --form "name=gitlab-ee" ``` Example response: -- cgit v1.2.1