VladPolskiy/gitlab-foss
1
0
Fork 0
mirror of https://gitlab.com/gitlab-org/gitlab-foss.git synced 2025-08-01 16:04:19 +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
2025-02-04 03:18:21 +00:00
parent 1b859cccfe
commit d69838f199
755 changed files with 21861 additions and 1468 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3,10 +3,9 @@ info: For assistance with this Style Guide page, see https://handbook.gitlab.com
stage: none
group: unassigned
description: 'Writing styles, markup, formatting, and other standards for the GitLab RESTful APIs.'
title: Documenting REST API resources
---
# Documenting REST API resources
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
@ -245,8 +244,8 @@ you can use in the API documentation.
WARNING:
Do not use information for real users, URLs, or tokens. For documentation, refer to our
relevant style guide sections on [Fake user information](styleguide/index.md#fake-user-information),
[Fake URLs](styleguide/index.md#fake-urls), and [Fake tokens](styleguide/index.md#fake-tokens).
relevant style guide sections on [Fake user information](styleguide/_index.md#fake-user-information),
[Fake URLs](styleguide/_index.md#fake-urls), and [Fake tokens](styleguide/_index.md#fake-tokens).
### Simple cURL command