Skip to content

G
gitlab-ce
Commit eb0ce610 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis
Browse files
Options

Merge branch 'docs-upgrade-list-to-table' into 'master' 

Docs: upgrade list of parameters to table of parameters

See merge request gitlab-org/gitlab!41467
parents f66f700f 84e95d6d
Hide whitespace changes
Inline Side-by-side
Showing with 19 additions and 11 deletions
doc/api/tags.md
View file @ eb0ce610
...@@ -117,11 +117,13 @@ POST /projects/:id/repository/tags ...@@ -117,11 +117,13 @@ POST /projects/:id/repository/tags
Parameters: Parameters:
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | Attribute | Type | Required | Description |
- `tag_name` (required) - The name of a tag | --------------------- | -------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
- `ref` (required) - Create tag using commit SHA, another tag name, or branch name. | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
- `message` (optional) - Creates annotated tag. | `tag_name` | string | yes | The name of a tag |
- `release_description` (optional) - Add release notes to the Git tag and store it in the GitLab database. | `ref` | string | yes | Create tag using commit SHA, another tag name, or branch name |
| `message` | string | no | Creates annotated tag |
| `release_description` | string | no | Add release notes to the Git tag and store it in the GitLab database |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/tags?tag_name=test&ref=master" curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/tags?tag_name=test&ref=master"
...@@ -177,8 +179,10 @@ DELETE /projects/:id/repository/tags/:tag_name ...@@ -177,8 +179,10 @@ DELETE /projects/:id/repository/tags/:tag_name
Parameters: Parameters:
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | Attribute | Type | Required | Description |
- `tag_name` (required) - The name of a tag | ---------- | -------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `tag_name` | string | yes | The name of a tag |
## Create a new release ## Create a new release
...@@ -191,8 +195,10 @@ POST /projects/:id/repository/tags/:tag_name/release ...@@ -191,8 +195,10 @@ POST /projects/:id/repository/tags/:tag_name/release
Parameters: Parameters:
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | Attribute | Type | Required | Description |
- `tag_name` (required) - The name of a tag | ---------- | -------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `tag_name` | string | yes | The name of a tag |
Request body: Request body:
...@@ -223,8 +229,10 @@ PUT /projects/:id/repository/tags/:tag_name/release ...@@ -223,8 +229,10 @@ PUT /projects/:id/repository/tags/:tag_name/release
Parameters: Parameters:
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | Attribute | Type | Required | Description |
- `tag_name` (required) - The name of a tag | ---------- | -------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `tag_name` | string | yes | The name of a tag |
Request body: Request body:
......
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7