Skip to content
Snippets Groups Projects

WIP - Documentation clean-up (api)

Closed WIP - Documentation clean-up (api)
axil/gitlab-ce:docs_refactor into master
Closed Achilleas Pipinellis requested to merge axil/gitlab-ce:docs_refactor into master

Relevant MR gitlab-org/gitlab-ce!635

All docs should:

  • 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
  • branches.md
  • commits.md
  • deploy_key_multiple_projects.md
  • deploy_keys.md
  • groups.md
  • issues.md
  • keys.md
  • labels.md
  • merge_requests.md
  • milestones.md
  • namespaces.md
  • notes.md
  • oauth2.md
  • project_snippets.md
  • projects.md
  • repositories.md
  • repository_files.md
  • services.md
  • session.md
  • settings.md
  • system_hooks.md
  • tags.md
  • users.md (!2089 (merged) and https://dev.gitlab.org/gitlab/gitlabhq/issues/1244#note_64122)

GitLab CI

  • README.md
  • builds.md
  • commits.md
  • projects.md
  • runners.md

Notes

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

\cc @DouweM @rspeicher @sytses

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Robert Speicher
  • Robert Speicher
    Robert Speicher @rspeicher started a thread on the diff
    • doc/api/README.md
    24
    25 Find API Clients for GitLab [on our website](https://about.gitlab.com/applications/#api-clients).
    26 You can use [GitLab as an OAuth2 client](oauth2.md) to make API calls.
    27
    28 ## Introduction
    23 ## Authentication
    29 24
    30 All API requests require authentication. You need to pass a `private_token` parameter by URL or header. If passed as header, the header name must be "PRIVATE-TOKEN" (capital and with dash instead of underscore). You can find or reset your private token in your profile.
    25 All API requests require authentication. You need to pass a `private_token`
    26 parameter by URL or header. If passed as a header, the header name must be
    27 **PRIVATE-TOKEN** (capital and with dash instead of underscore). You can find or
    28 reset your private token in your account page (`/profile/account`).
    31 29
    32 If no, or an invalid, `private_token` is provided then an error message will be returned with status code 401:
    30 If no, or an invalid, `private_token` is provided then an error message will be
    31 returned with status code `401`:
  • Robert Speicher
  • Robert Speicher
  • Robert Speicher
  • Robert Speicher
  • Robert Speicher
    Robert Speicher @rspeicher started a thread on the diff
    • doc/api/README.md
    170 193
    171 194 When an attribute is missing, you will get something like:
    172 195
    173 HTTP/1.1 400 Bad Request
    174 Content-Type: application/json
    196 ```json
    197 HTTP/1.1 400 Bad Request
    198 Content-Type: application/json
  • Robert Speicher
  • Achilleas Pipinellis Added 1 commit:

    Added 1 commit:

    • d9fe9afc - Fix typos and grammar.
  • Achilleas Pipinellis Milestone changed to 7.13

    Milestone changed to 7.13

  • Achilleas Pipinellis Milestone changed to 7.14

    Milestone changed to 7.14

  • Achilleas Pipinellis
    Achilleas Pipinellis @axil ·
    Author Maintainer

    I'm going to split this up in multiple MRs. It's not sane to do the clean-up in one go.

  • Achilleas Pipinellis Added ~13884 label

    Added ~13884 label

  • Achilleas Pipinellis Title changed from WIP - Documentation clean-up. to WIP - Documentation clean-up (api)

    Title changed from WIP - Documentation clean-up. to WIP - Documentation clean-up (api)

  • Achilleas Pipinellis Added 1003 commits:

    Added 1003 commits:

    • d9fe9afc...41e6b8d8 - 1000 commits from branch gitlab-org:master
    • cee02f01 - Clean up, api/readme.md.
    • c67bc0cc - Fix typos and grammar.
    • cfab7b17 - Clean-up session.
    Toggle commit list
  • Achilleas Pipinellis Added 993 commits:

    Added 993 commits:

    • cfab7b17...a429eb4d - 989 commits from branch gitlab-org:master
    • 748c5d20 - Clean up, api/readme.md.
    • a934d368 - Fix typos and grammar.
    • ceaea46c - Clean-up session.
    • d39cbcca - Change styleguide for new API docs
    Toggle commit list
  • Achilleas Pipinellis Added 1 commit:

    Added 1 commit:

    • 62454c0b - Fix typos and identation
  • Achilleas Pipinellis Added 1 commit:

    Added 1 commit:

    • 49d12778 - Change styleguide for new API docs
  • Achilleas Pipinellis Added 1 commit:

    Added 1 commit:

    • b944ddfe - Clean up branches.md
  • Achilleas Pipinellis Added 1 commit:

    Added 1 commit:

    • 51fc6d5c - Clean up commits.md
  • Achilleas Pipinellis Added 1 commit:

    Added 1 commit:

    • 7991307b - Be consistent with new API styleguide
  • Achilleas Pipinellis Added 1 commit:

    Added 1 commit:

    • d5727e97 - Clean up deploy_keys.md
  • Achilleas Pipinellis Added 1 commit:

    Added 1 commit:

    • 69bf9128 - Add missing header "Content-Type: application/json"
  • Achilleas Pipinellis Milestone changed to 8.1

    Milestone changed to 8.1

  • Achilleas Pipinellis Added 865 commits:

    Added 865 commits:

    • 69bf9128...1ca11993 - 856 commits from branch gitlab-org:master
    • 37c6b81e - Clean up, api/readme.md.
    • 58d460a5 - Fix typos and grammar.
    • bdca9f18 - Clean-up session.
    • b2b1104c - Change styleguide for new API docs
    • ec124acb - Clean up branches.md
    • d9b33075 - Clean up commits.md
    • a67387b3 - Be consistent with new API styleguide
    • a1b5198c - Clean up deploy_keys.md
    • d27eb72a - Add missing header "Content-Type: application/json"
    Toggle commit list
  • Achilleas Pipinellis Milestone changed to 8.4

    Milestone changed to 8.4

  • Achilleas Pipinellis Added 931 commits:

    Added 931 commits:

    • d27eb72a...95da91a6 - 913 commits from branch gitlab-org:master
    • 63970ece - Clean up, api/readme.md.
    • 67d232b7 - Fix typos and grammar.
    • 39acd70e - Clean-up session.
    • 9d77dd7f - Change styleguide for new API docs
    • 499512a9 - Clean up branches.md
    • 8e8da4c6 - Clean up commits.md
    • 3cacacf9 - Be consistent with new API styleguide
    • 3d105225 - Clean up deploy_keys.md
    • d3d6a43e - Add missing header "Content-Type: application/json"
    • cadba358 - Replace localhost with gitlab.example.com
    • 66dd4c43 - Refactor groups.md
    • f4a0d65f - Add example to post data using json content
    • 62b0bb54 - Replace json data with simple API call
    • a2bf24d6 - Several fixes
    • d83a7d29 - Clean up session.md
    • 46a3c94c - Clean up keys.md
    • d5a963fe - Clean up labels.md
    • 2f32c775 - Add curl example of using the --data option
    Toggle commit list
  • Achilleas Pipinellis Added 1 commit:

    Added 1 commit:

    • fedfa535 - Clean up system_hooks.md
  • Achilleas Pipinellis mentioned in issue #3472 (closed)

    mentioned in issue #3472 (closed)

  • Achilleas Pipinellis Added 169 commits:

    Added 169 commits:

    • fedfa535...12b35c6f - 149 commits from branch gitlab-org:master
    • 0ed8f2c1 - Clean up, api/readme.md.
    • 1ca24a25 - Fix typos and grammar.
    • 290a7922 - Clean-up session.
    • 78104ed1 - Change styleguide for new API docs
    • 690fbcf5 - Clean up branches.md
    • f4463fab - Clean up commits.md
    • 8c16592b - Be consistent with new API styleguide
    • 916f9729 - Clean up deploy_keys.md
    • d550d25e - Add missing header "Content-Type: application/json"
    • 264b326d - Replace localhost with gitlab.example.com
    • 636465a1 - Refactor groups.md
    • 7e2784af - Add example to post data using json content
    • da9f08fc - Replace json data with simple API call
    • 14120a44 - Several fixes
    • 3d00eab7 - Clean up session.md
    • d26a24ad - Clean up keys.md
    • f52ce2de - Clean up labels.md
    • bcfef725 - Add curl example of using the --data option
    • 81189cee - Clean up system_hooks.md
    • 75279cf2 - Add example of curl posting using form-data
    Toggle commit list
  • Achilleas Pipinellis
    Achilleas Pipinellis @axil ·
    Author Maintainer

    Note to self, in users API: gitlab-org/gitlab-ce!2089

  • Achilleas Pipinellis mentioned in merge request !2078 (closed)

    mentioned in merge request !2078 (closed)

  • Achilleas Pipinellis mentioned in issue #4217 (closed)

    mentioned in issue #4217 (closed)

  • Achilleas Pipinellis mentioned in issue #4218 (closed)

    mentioned in issue #4218 (closed)

  • Achilleas Pipinellis mentioned in issue #4259 (closed)

    mentioned in issue #4259 (closed)

  • Achilleas Pipinellis Reassigned to @axil

    Reassigned to @axil

  • Achilleas Pipinellis Marked the task issues.md as completed

    Marked the task issues.md as completed

  • Achilleas Pipinellis Added 1915 commits:

    Added 1915 commits:

    • 75279cf2...0d59e7b9 - 1910 commits from branch gitlab-org:master
    • 815ed096 - Merge branch 'master' into docs_refactor
    • ba559c4b - Add example of special chars in curl requests
    • 85e9d1fe - Pluralize heading
    • 237bee4a - Clean up issues API resource
    • 4a86d092 - Merge branch 'master' into docs_refactor
    Toggle commit list
  • Achilleas Pipinellis Added 56 commits:

    Added 56 commits:

    Toggle commit list
  • Achilleas Pipinellis Marked the task settings.md as completed

    Marked the task settings.md as completed

  • Achilleas Pipinellis Added 36 commits:

    Added 36 commits:

    Toggle commit list
  • Achilleas Pipinellis Marked the task namespaces.md as completed

    Marked the task namespaces.md as completed

  • Achilleas Pipinellis Marked the task Document that groups can only created by users which are allowed to create groups, see https://gitlab.com/gitlab-org/gitlab-ce/issues/4259#note_3031554 as completed

    Marked the task Document that groups can only created by users which are allowed to create groups, see https://gitlab.com/gitlab-org/gitlab-ce/issues/4259#note_3031554 as completed

  • Achilleas Pipinellis mentioned in issue #6064 (moved)

    mentioned in issue #6064 (moved)

  • Achilleas Pipinellis Added 2 commits:

    Added 2 commits:

    • f7f00527 - Clean up API README.md
    • acc86ac8 - Move doc_styleguide in the development directory
  • Achilleas Pipinellis mentioned in issue #10421 (moved)

    mentioned in issue #10421 (moved)

  • Achilleas Pipinellis
    Achilleas Pipinellis @axil ·
    Author Maintainer

    I will split this up to many smaller MRs. Closing in favor of https://gitlab.com/gitlab-org/gitlab-ce/issues/10421.

  • Achilleas Pipinellis Status changed to closed

    Status changed to closed

    • Please register or sign in to reply