diff options
| author | Achilleas Pipinellis <axil@gitlab.com> | 2018-09-03 13:18:42 +0300 |
|---|---|---|
| committer | Achilleas Pipinellis <axil@gitlab.com> | 2018-09-03 13:18:42 +0300 |
| commit | 8cb39fa8da9d2b7c54d2167c69abd045d6d1f347 (patch) | |
| tree | 688a5ad4b05e4091b09e207d5561486bedde7b5e /doc/api | |
| parent | 0c8b219d2bc7c307411c0c368353faaa9cdbd09b (diff) | |
| parent | 726407e8c0681123bbbe624c37ba857b28d8951b (diff) | |
Merge branch 'docs-port-ee-community-contributions' into 'master'
Docs port ee community contributions
See merge request gitlab-org/gitlab-ce!21311
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/groups.md | 2 | ||||
| -rw-r--r-- | doc/api/projects.md | 2 | ||||
| -rw-r--r-- | doc/api/tags.md | 22 |
3 files changed, 24 insertions, 2 deletions
diff --git a/doc/api/groups.md b/doc/api/groups.md index 64e0d78788d..be75c363a40 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -82,7 +82,7 @@ You can filter by [custom attributes](custom_attributes.md) with: GET /groups?custom_attributes[key]=value&custom_attributes[other_key]=other_value ``` -## List a groups's subgroups +## List a group's subgroups > [Introduced][ce-15142] in GitLab 10.3. diff --git a/doc/api/projects.md b/doc/api/projects.md index 0936ff52dae..86acb96357d 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -710,7 +710,7 @@ PUT /projects/:id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) | -| `name` | string | yes | The name of the project | +| `name` | string | no | The name of the project | | `path` | string | no | Custom repository name for the project. By default generated based on name | | `default_branch` | string | no | `master` by default | | `description` | string | no | Short project description | diff --git a/doc/api/tags.md b/doc/api/tags.md index 4af096c3c0c..f2a3f9f28d2 100644 --- a/doc/api/tags.md +++ b/doc/api/tags.md @@ -174,10 +174,21 @@ Parameters: - `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user - `tag_name` (required) - The name of a tag + +Request body: + - `description` (required) - Release notes with markdown support ```json { + "description": "Amazing release. Wow" +} +``` + +Response: + +```json +{ "tag_name": "1.0.0", "description": "Amazing release. Wow" } @@ -195,10 +206,21 @@ Parameters: - `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user - `tag_name` (required) - The name of a tag + +Request body: + - `description` (required) - Release notes with markdown support ```json { + "description": "Amazing release. Wow" +} +``` + +Response: + +```json +{ "tag_name": "1.0.0", "description": "Amazing release. Wow" } |