VladPolskiy/gitlab-foss
1
0
Fork 0
mirror of https://gitlab.com/gitlab-org/gitlab-foss.git synced 2025-08-10 01:31:45 +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-04-06 21:12:03 +00:00
parent 06e8461179
commit 79b6126c78
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -16,9 +16,10 @@ When modifying the Markdown or API code, also update the corresponding
To check if the OpenAPI definition needs to be updated, you can run `bin/rake gitlab:openapi:check_docs`. To check if the OpenAPI definition needs to be updated, you can run `bin/rake gitlab:openapi:check_docs`.
This is also checked by the `openapi-doc-check` CI/CD job that runs for commits that modify API code or documentation. This is also checked by the `openapi-doc-check` CI/CD job that runs for commits that modify API code or documentation.
In the Markdown doc for a resource (AKA endpoint): In the Markdown doc for a resource (the API endpoint):
- Every method must have the REST API request. For example: - Every method must have the REST API request. The request should include the HTTP method
(like GET, PUT, DELETE) followed by the request path. The path should always start with a `/`. For example:
```plaintext ```plaintext
GET /api/v4/projects/:id/repository/branches GET /api/v4/projects/:id/repository/branches