diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-09-20 02:18:09 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-09-20 02:18:09 +0300 |
| commit | 6ed4ec3e0b1340f96b7c043ef51d1b33bbe85fde (patch) | |
| tree | dc4d20fe6064752c0bd323187252c77e0a89144b /doc/development/documentation/restful_api_styleguide.md | |
| parent | 9868dae7fc0655bd7ce4a6887d4e6d487690eeed (diff) | |
Add latest changes from gitlab-org/gitlab@15-4-stable-eev15.4.0-rc42
Diffstat (limited to 'doc/development/documentation/restful_api_styleguide.md')
| -rw-r--r-- | doc/development/documentation/restful_api_styleguide.md | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/doc/development/documentation/restful_api_styleguide.md b/doc/development/documentation/restful_api_styleguide.md index bf1461a810d..2991c1b3224 100644 --- a/doc/development/documentation/restful_api_styleguide.md +++ b/doc/development/documentation/restful_api_styleguide.md @@ -59,12 +59,12 @@ METHOD /endpoint Supported attributes: -| Attribute | Type | Required | Description | -|:-------------------------|:---------|:-----------------------|:----------------------| -| `attribute` | datatype | **{check-circle}** Yes | Detailed description. | -| `attribute` **(<tier>)** | datatype | **{dotted-circle}** No | Detailed description. | -| `attribute` | datatype | **{dotted-circle}** No | Detailed description. | -| `attribute` | datatype | **{dotted-circle}** No | Detailed description. | +| Attribute | Type | Required | Description | +|:-------------------------|:---------|:---------|:----------------------| +| `attribute` | datatype | Yes | Detailed description. | +| `attribute` **(<tier>)** | datatype | No | Detailed description. | +| `attribute` | datatype | No | Detailed description. | +| `attribute` | datatype | No | Detailed description. | If successful, returns [`<status_code>`](../../api/index.md#status-codes) and the following response attributes: @@ -123,13 +123,13 @@ To deprecate an attribute: 1. Add inline deprecation text to the description. ```markdown - | Attribute | Type | Required | Description | - |:--------------|:-------|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------| - | `widget_name` | string | **{dotted-circle}** No | [Deprecated](<link-to-issue>) in GitLab 14.7 and is planned for removal in 15.4. Use `widget_id` instead. The name of the widget. | + | Attribute | Type | Required | Description | + |:--------------|:-------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------| + | `widget_name` | string | No | [Deprecated](<link-to-issue>) in GitLab 14.7 and is planned for removal in 15.4. Use `widget_id` instead. The name of the widget. | ``` To widely announce a deprecation, or if it's a breaking change, -[update the deprecations and removals documentation](../deprecation_guidelines/#update-the-deprecations-and-removals-documentation). +[update the deprecations and removals documentation](../deprecation_guidelines/index.md#update-the-deprecations-and-removals-documentation). ## Method description @@ -139,20 +139,20 @@ always be in code blocks using backticks (`` ` ``). Sort the table by required attributes first, then alphabetically. ```markdown -| Attribute | Type | Required | Description | -|:-----------------------------|:--------------|:-----------------------|:----------------------------------------------------| -| `title` | string | **{check-circle}** Yes | Title of the issue. | -| `assignee_ids` **(PREMIUM)** | integer array | **{dotted-circle}** No | IDs of the users to assign the issue to. | -| `confidential` | boolean | **{dotted-circle}** No | Sets the issue to confidential. Default is `false`. | +| Attribute | Type | Required | Description | +|:-----------------------------|:--------------|:---------|:----------------------------------------------------| +| `title` | string | Yes | Title of the issue. | +| `assignee_ids` **(PREMIUM)** | integer array | No | IDs of the users to assign the issue to. | +| `confidential` | boolean | No | Sets the issue to confidential. Default is `false`. | ``` Rendered example: -| Attribute | Type | Required | Description | -|:-----------------------------|:--------------|:-----------------------|:----------------------------------------------------| -| `title` | string | **{check-circle}** Yes | Title of the issue. | -| `assignee_ids` **(PREMIUM)** | integer array | **{dotted-circle}** No | IDs of the users to assign the issue to. | -| `confidential` | boolean | **{dotted-circle}** No | Sets the issue to confidential. Default is `false`. | +| Attribute | Type | Required | Description | +|:-----------------------------|:--------------|:---------|:----------------------------------------------------| +| `title` | string | Yes | Title of the issue. | +| `assignee_ids` **(PREMIUM)** | integer array | No | IDs of the users to assign the issue to. | +| `confidential` | boolean | No | Sets the issue to confidential. Default is `false`. | For information about writing attribute descriptions, see the [GraphQL API description style guide](../api_graphql_styleguide.md#description-style-guide). |