VladPolskiy/gitlab-foss
1
0
Fork 0
mirror of https://gitlab.com/gitlab-org/gitlab-foss.git synced 2025-07-25 16:03:48 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

Add latest changes from gitlab-org/gitlab@master

Browse Source
This commit is contained in:
GitLab Bot
2023-02-06 00:08:40 +00:00
parent 836cde6d62
commit bd9860f691
8 changed files with 36 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/development/documentation/restful_api_styleguide.md
View File

@ -9,7 +9,8 @@ description: 'Writing styles, markup, formatting, and other standards for the Gi
REST API resources are documented in Markdown under
[`/doc/api`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api). Each
resource has its own Markdown file, which is linked from `api_resources.md`.
resource has its own Markdown file, which is linked from
[`api_resources.md`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/api_resources.md).
When modifying the Markdown, also update the corresponding
[OpenAPI definition](https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/openapi)
@ -35,6 +36,8 @@ In the Markdown doc for a resource (AKA endpoint):
Put the badge in the **Attribute** column, like the
`**(<tier>)**` code in the following template.
After a new API documentation page is added, [add an entry in the global navigation](site_architecture/global_nav.md#add-a-navigation-entry). [Example](https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests/3497).
## API topic template
Use the following template to help you get started. Be sure to list any
@ -66,7 +69,7 @@ Supported attributes:
| `attribute` | datatype | No | Detailed description. |
| `attribute` | datatype | No | Detailed description. |
If successful, returns [`<status_code>`](../../api/rest/index.md#status-codes) and the following
If successful, returns [`<status_code>`](rest/index.md#status-codes) and the following
response attributes:
| Attribute | Type | Description |