Refactor documentation API
This is a meta issue to track the status of API documentation refactoring. Taken from gitlab-foss!681 (closed).
All docs should follow the documentation styleguide:
- Use tables for attributes
- Use one curl example with each method call
- Make sure every method call has a response body (in json format)
GitLab
-
README.md - gitlab-foss!2476 (merged), gitlab-foss!25076 (merged), https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/9509 -
Applications - gitlab-foss!24212 (merged) -
Avatar - gitlab-foss!24258 (merged) -
Award Emoji - gitlab-foss!24288 (merged) -
branches.md - gitlab-foss!2464 (merged), gitlab-foss!24290 (merged) -
Broadcast messages - gitlab-foss!24920 (merged) -
builds.md gitlab-foss!2207 (merged) -
build_triggers.md - gitlab-foss!2286 (merged) -
build_variables.md gitlab-foss!2264 (merged) -
commits.md - gitlab-foss!2465 (merged) -
deploy_key_multiple_projects.md - gitlab-foss!2468 (merged) -
deploy_keys.md - gitlab-foss!2467 (merged) -
files.md - non-existent -
groups.md - gitlab-foss!2469 (closed) -
issues.md - gitlab-foss!2466 (merged) -
keys.md - gitlab-foss!2470 (closed) -
labels.md - gitlab-foss!2471 (merged) -
merge_requests.md -
milestones.md -
namespaces.md - gitlab-foss!2472 (merged) -
notes.md -
oauth2.md -
project_snippets.md -
projects.md -
repositories.md -
repository_files.md -
services.md -
session.md - gitlab-foss!2473 (merged) -
settings.md - gitlab-foss!2474 (merged) -
Snippets - gitlab-foss!24921 (merged) -
system_hooks.md - gitlab-foss!2475 (merged) -
tags.md -
users.md -
v3_to_v4.md - gitlab-foss#39479 (moved)
GitLab CI
-
README.md -
builds.md gitlab-foss!2207 (merged) -
commits.md gitlab-foss!2465 (merged) -
projects.md -
runners.md
Notes
-
Document that groups can only created by users which are allowed to create groups, see gitlab-foss#4259 (comment 3031554) -
Inconsistency between doc and API for user update gitlab-foss#1042 (closed) -
users.md (gitlab-foss!2089 (merged) and https://dev.gitlab.org/gitlab/gitlabhq/issues/1244#note_64122) -
Confusion between id
andiid
- gitlab-foss!4030 (merged)
Sorted by word count
89 milestones.md
102 oauth2.md
110 repository_files.md
118 project_snippets.md
150 tags.md
178 repositories.md
249 README.md
261 notes.md
474 merge_requests.md
575 users.md
696 services.md
818 projects.md
Edited by Achilleas Pipinellis