Commit 51d94529 authored by Marcel Amirault's avatar Marcel Amirault

Merge branch 'docs-aqualls-20200226.2-codeblocks' into 'master'

Docs: Update API code blocks

See merge request gitlab-org/gitlab!26018
parents b91df0ad 5a1dc482
......@@ -4,7 +4,7 @@
Import your projects from GitHub to GitLab via the API.
```
```plaintext
POST /import/github
```
......
......@@ -5,7 +5,7 @@
Get a list of related issues of a given issue, sorted by the relationship creation datetime (ascending).
Issues will be filtered according to the user authorizations.
```
```plaintext
GET /projects/:id/issues/:issue_iid/links
```
......@@ -57,7 +57,7 @@ Parameters:
Creates a two-way relation between two issues. User must be allowed to update both issues in order to succeed.
```
```plaintext
POST /projects/:id/issues/:issue_iid/links
```
......@@ -145,7 +145,7 @@ Example response:
Deletes an issue link, thus removes the two-way relationship.
```
```plaintext
DELETE /projects/:id/issues/:issue_iid/links/:issue_link_id
```
......
......@@ -26,7 +26,7 @@ Get all issues the authenticated user has access to. By default it
returns only issues created by the current user. To get all issues,
use parameter `scope=all`.
```
```plaintext
GET /issues
GET /issues?state=opened
GET /issues?state=closed
......@@ -181,7 +181,7 @@ the `weight` parameter:
Get a list of a group's issues.
```
```plaintext
GET /groups/:id/issues
GET /groups/:id/issues?state=opened
GET /groups/:id/issues?state=closed
......@@ -336,7 +336,7 @@ the `weight` parameter:
Get a list of a project's issues.
```
```plaintext
GET /projects/:id/issues
GET /projects/:id/issues?state=opened
GET /projects/:id/issues?state=closed
......@@ -497,7 +497,7 @@ the `weight` parameter:
Get a single project issue.
```
```plaintext
GET /projects/:id/issues/:issue_iid
```
......@@ -637,7 +637,7 @@ Please use `iid` of the `epic` attribute instead.
Creates a new project issue.
```
```plaintext
POST /projects/:id/issues
```
......@@ -745,7 +745,7 @@ the `weight` parameter:
Updates an existing project issue. This call is also used to mark an issue as
closed.
```
```plaintext
PUT /projects/:id/issues/:issue_iid
```
......@@ -864,7 +864,7 @@ The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value
Only for admins and project owners. Deletes the issue in question.
```
```plaintext
DELETE /projects/:id/issues/:issue_iid
```
......@@ -886,7 +886,7 @@ issue, error `400` together with an explaining error message is returned.
If a given label and/or milestone with the same name also exists in the target
project, it will then be assigned to the issue that is being moved.
```
```plaintext
POST /projects/:id/issues/:issue_iid/move
```
......@@ -993,7 +993,7 @@ Subscribes the authenticated user to an issue to receive notifications.
If the user is already subscribed to the issue, the status code `304`
is returned.
```
```plaintext
POST /projects/:id/issues/:issue_iid/subscribe
```
......@@ -1099,7 +1099,7 @@ Unsubscribes the authenticated user from the issue to not receive notifications
from it. If the user is not subscribed to the issue, the
status code `304` is returned.
```
```plaintext
POST /projects/:id/issues/:issue_iid/unsubscribe
```
......@@ -1170,7 +1170,7 @@ Manually creates a todo for the current user on an issue. If
there already exists a todo for the user on that issue, status code `304` is
returned.
```
```plaintext
POST /projects/:id/issues/:issue_iid/todo
```
......@@ -1284,7 +1284,7 @@ Example response:
Sets an estimated time of work for this issue.
```
```plaintext
POST /projects/:id/issues/:issue_iid/time_estimate
```
......@@ -1313,7 +1313,7 @@ Example response:
Resets the estimated time for this issue to 0 seconds.
```
```plaintext
POST /projects/:id/issues/:issue_iid/reset_time_estimate
```
......@@ -1341,7 +1341,7 @@ Example response:
Adds spent time for this issue
```
```plaintext
POST /projects/:id/issues/:issue_iid/add_spent_time
```
......@@ -1370,7 +1370,7 @@ Example response:
Resets the total spent time for this issue to 0 seconds.
```
```plaintext
POST /projects/:id/issues/:issue_iid/reset_spent_time
```
......@@ -1396,7 +1396,7 @@ Example response:
## Get time tracking stats
```
```plaintext
GET /projects/:id/issues/:issue_iid/time_stats
```
......@@ -1424,7 +1424,7 @@ Example response:
Get all the merge requests that are related to the issue.
```
```plaintext
GET /projects/:id/issues/:issue_id/related_merge_requests
```
......@@ -1580,7 +1580,7 @@ Example response:
Get all the merge requests that will close issue when merged.
```
```plaintext
GET /projects/:id/issues/:issue_iid/closed_by
```
......@@ -1653,7 +1653,7 @@ Example response:
## Participants on issues
```
```plaintext
GET /projects/:id/issues/:issue_iid/participants
```
......@@ -1697,7 +1697,7 @@ Comments are done via the [notes](notes.md) resource.
Available only for admins.
```
```plaintext
GET /projects/:id/issues/:issue_iid/user_agent_detail
```
......
......@@ -11,7 +11,7 @@ Gets issues count statistics on all issues the authenticated user has access to.
returns only issues created by the current user. To get all issues,
use parameter `scope=all`.
```
```plaintext
GET /issues_statistics
GET /issues_statistics?labels=foo
GET /issues_statistics?labels=foo,bar
......@@ -67,7 +67,7 @@ Example response:
Gets issues count statistics for given group.
```
```plaintext
GET /groups/:id/issues_statistics
GET /groups/:id/issues_statistics?labels=foo
GET /groups/:id/issues_statistics?labels=foo,bar
......
......@@ -4,7 +4,7 @@
Get a list of jobs in a project. Jobs are sorted in descending order of their IDs.
```
```plaintext
GET /projects/:id/jobs
```
......@@ -138,7 +138,7 @@ Example of response
Get a list of jobs for a pipeline.
```
```plaintext
GET /projects/:id/pipelines/:pipeline_id/jobs
```
......@@ -273,7 +273,7 @@ Example of response
Get a single job of a project
```
```plaintext
GET /projects/:id/jobs/:job_id
```
......@@ -351,7 +351,7 @@ Example of response
Get the job's artifacts zipped archive of a project.
```
```plaintext
GET /projects/:id/jobs/:job_id/artifacts
```
......@@ -414,7 +414,7 @@ the given reference name and job, provided the job finished successfully. This
is the same as [getting the job's artifacts](#get-job-artifacts), but by
defining the job's name instead of its ID.
```
```plaintext
GET /projects/:id/jobs/artifacts/:ref_name/download?job=name
```
......@@ -476,7 +476,7 @@ Download a single artifact file from a job with a specified ID from within
the job's artifacts zipped archive. The file is extracted from the archive and
streamed to the client.
```
```plaintext
GET /projects/:id/jobs/:job_id/artifacts/*artifact_path
```
......@@ -510,7 +510,7 @@ Download a single artifact file for a specific job of the latest successful
pipeline for the given reference name from within the job's artifacts archive.
The file is extracted from the archive and streamed to the client.
```
```plaintext
GET /projects/:id/jobs/artifacts/:ref_name/raw/*artifact_path?job=name
```
......@@ -541,7 +541,7 @@ Possible response status codes:
Get a log (trace) of a specific job of a project:
```
```plaintext
GET /projects/:id/jobs/:job_id/trace
```
......@@ -565,7 +565,7 @@ Possible response status codes:
Cancel a single job of a project
```
```plaintext
POST /projects/:id/jobs/:job_id/cancel
```
......@@ -614,7 +614,7 @@ Example of response
Retry a single job of a project
```
```plaintext
POST /projects/:id/jobs/:job_id/retry
```
......@@ -663,7 +663,7 @@ Example of response
Erase a single job of a project (remove job artifacts and a job log)
```
```plaintext
POST /projects/:id/jobs/:job_id/erase
```
......@@ -717,7 +717,7 @@ Example of response
Prevents artifacts from being deleted when expiration is set.
```
```plaintext
POST /projects/:id/jobs/:job_id/artifacts/keep
```
......@@ -773,7 +773,7 @@ Example response:
Delete artifacts of a job.
```
```plaintext
DELETE /projects/:id/jobs/:job_id/artifacts
```
......@@ -797,7 +797,7 @@ If the artifacts were deleted successfully, a response with status `204 No Conte
Triggers a manual action to start a job.
```
```plaintext
POST /projects/:id/jobs/:job_id/play
```
......
......@@ -7,7 +7,7 @@ The `description_html` - was added to response JSON in [GitLab 12.7](https://git
Get all labels for a given project.
```
```plaintext
GET /projects/:id/labels
```
......@@ -102,7 +102,7 @@ Example response:
Get a single label for a given project.
```
```plaintext
GET /projects/:id/labels/:label_id
```
......@@ -139,7 +139,7 @@ Example response:
Creates a new label for the given repository with the given name and color.
```
```plaintext
POST /projects/:id/labels
```
......@@ -178,7 +178,7 @@ Example response:
Deletes a label with a given name.
```
```plaintext
DELETE /projects/:id/labels/:label_id
```
......@@ -198,7 +198,7 @@ NOTE: **Note:** An older endpoint `DELETE /projects/:id/labels` with `name` in t
Updates an existing label with new name or new color. At least one parameter
is required, to update the label.
```
```plaintext
PUT /projects/:id/labels/:label_id
```
......@@ -242,7 +242,7 @@ NOTE: **Note:** An older endpoint `PUT /projects/:id/labels` with `name` or `lab
Promotes a project label to a group label.
```
```plaintext
PUT /projects/:id/labels/:label_id/promote
```
......@@ -279,7 +279,7 @@ Subscribes the authenticated user to a label to receive notifications.
If the user is already subscribed to the label, the status code `304`
is returned.
```
```plaintext
POST /projects/:id/labels/:label_id/subscribe
```
......@@ -317,7 +317,7 @@ Unsubscribes the authenticated user from a label to not receive notifications
from it. If the user is not subscribed to the label, the
status code `304` is returned.
```
```plaintext
POST /projects/:id/labels/:label_id/unsubscribe
```
......
......@@ -5,7 +5,7 @@ as an admin.
## Retrieve information about the current license
```
```plaintext
GET /license
```
......@@ -34,7 +34,7 @@ GET /license
## Retrieve information about all licenses
```
```plaintext
GET /licenses
```
......@@ -93,7 +93,7 @@ Returns:
## Add a new license
```
```plaintext
POST /license
```
......@@ -137,7 +137,7 @@ Returns:
## Delete a license
```
```plaintext
DELETE /license/:id
```
......
......@@ -4,7 +4,7 @@
Checks if your `.gitlab-ci.yml` file is valid.
```
```plaintext
POST /ci/lint
```
......
......@@ -4,7 +4,7 @@
Get all managed licenses for a given project.
```
```plaintext
GET /projects/:id/managed_licenses
```
......@@ -37,7 +37,7 @@ Example response:
Shows an existing managed license.
```
```plaintext
GET /projects/:id/managed_licenses/:managed_license_id
```
......@@ -64,7 +64,7 @@ Example response:
Creates a new managed license for the given project with the given name and approval status.
```
```plaintext
POST /projects/:id/managed_licenses
```
......@@ -92,7 +92,7 @@ Example response:
Deletes a managed license with a given id.
```
```plaintext
DELETE /projects/:id/managed_licenses/:managed_license_id
```
......@@ -111,7 +111,7 @@ When successful, it replies with an HTTP 204 response.
Updates an existing managed license with a new approval status.
```
```plaintext
PATCH /projects/:id/managed_licenses/:managed_license_id
```
......
......@@ -6,7 +6,7 @@ Available only in APIv4.
## Render an arbitrary Markdown document
```
```plaintext
POST /api/v4/markdown
```
......
......@@ -17,7 +17,7 @@ The access levels are defined in the `Gitlab::Access` module. Currently, these l
Gets a list of group or project members viewable by the authenticated user.
Returns only direct members and not inherited members through ancestors groups.
```
```plaintext
GET /groups/:id/members
GET /projects/:id/members
```
......@@ -72,7 +72,7 @@ Gets a list of group or project members viewable by the authenticated user, incl
When a user is a member of the project/group and of one or more ancestor groups the user is returned only once with the project `access_level` (if exists)
or the `access_level` for the user in the first group which they belong to in the project groups ancestors chain.
```
```plaintext
GET /groups/:id/members/all
GET /projects/:id/members/all
```
......@@ -136,7 +136,7 @@ Example response:
Gets a member of a group or project. Returns only direct members and not inherited members through ancestor groups.
```
```plaintext
GET /groups/:id/members/:user_id
GET /projects/:id/members/:user_id
```
......@@ -173,7 +173,7 @@ Example response:
Gets a member of a group or project, including members inherited through ancestor groups. See the corresponding [endpoint to list all inherited members](#list-all-members-of-a-group-or-project-including-inherited-members) for details.
```
```plaintext
GET /groups/:id/members/all/:user_id
GET /projects/:id/members/all/:user_id
```
......@@ -208,7 +208,7 @@ Example response:
Adds a member to a group or project.
```
```plaintext
POST /groups/:id/members
POST /projects/:id/members
```
......@@ -245,7 +245,7 @@ Example response:
Updates a member of a group or project.
```
```plaintext
PUT /groups/:id/members/:user_id
PUT /projects/:id/members/:user_id
```
......@@ -282,7 +282,7 @@ Example response:
Removes a user from a group or project.
```
```plaintext
DELETE /groups/:id/members/:user_id
DELETE /projects/:id/members/:user_id
```
......
......@@ -11,7 +11,7 @@ Configuration for approvals on all Merge Requests (MR) in the project. Must be a
You can request information about a project's approval configuration using the
following endpoint:
```
```plaintext
GET /projects/:id/approvals
```
......@@ -39,7 +39,7 @@ GET /projects/:id/approvals
If you are allowed to, you can change approval configuration using the following
endpoint:
```
```plaintext
POST /projects/:id/approvals
```
......@@ -73,7 +73,7 @@ POST /projects/:id/approvals
You can request information about a project's approval rules using the following endpoint:
```
```plaintext
GET /projects/:id/approval_rules
```
......@@ -172,7 +172,7 @@ GET /projects/:id/approval_rules
You can create project approval rules using the following endpoint:
```
```plaintext
POST /projects/:id/approval_rules
```
......@@ -274,7 +274,7 @@ POST /projects/:id/approval_rules
You can update project approval rules using the following endpoint:
```
```plaintext
PUT /projects/:id/approval_rules/:approval_rule_id
```
......@@ -379,7 +379,7 @@ PUT /projects/:id/approval_rules/:approval_rule_id
You can delete project approval rules using the following endpoint:
```
```plaintext
DELETE /projects/:id/approval_rules/:approval_rule_id
```
......@@ -398,7 +398,7 @@ DELETE /projects/:id/approval_rules/:approval_rule_id
If you are allowed to, you can change approvers and approver groups using
the following endpoint:
```
```plaintext
PUT /projects/:id/approvers
```
......@@ -464,7 +464,7 @@ Configuration for approvals on a specific Merge Request. Must be authenticated f
You can request information about a merge request's approval status using the
following endpoint:
```
```plaintext
GET /projects/:id/merge_requests/:merge_request_iid/approvals
```
......@@ -510,7 +510,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/approvals
If you are allowed to, you can change `approvals_required` using the following
endpoint:
```
```plaintext
POST /projects/:id/merge_requests/:merge_request_iid/approvals
```
......@@ -547,7 +547,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/approvals
If you are allowed to, you can change approvers and approver groups using
the following endpoint:
```
```plaintext
PUT /projects/:id/merge_requests/:merge_request_iid/approvers
```
......@@ -617,7 +617,7 @@ PUT /projects/:id/merge_requests/:merge_request_iid/approvers
You can request information about a merge request's approval state by using the following endpoint:
```
```plaintext
GET /projects/:id/merge_requests/:merge_request_iid/approval_state
```
......@@ -688,7 +688,7 @@ This includes additional information about the users who have already approved
You can request information about a merge request's approval rules using the following endpoint:
```
```plaintext
GET /projects/:id/merge_requests/:merge_request_iid/approval_rules
```
......@@ -764,7 +764,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/approval_rules
You can create merge request approval rules using the following endpoint:
```
```plaintext
POST /projects/:id/merge_requests/:merge_request_iid/approval_rules
```
......@@ -847,7 +847,7 @@ will be used.
You can update merge request approval rules using the following endpoint:
```
```plaintext
PUT /projects/:id/merge_requests/:merge_request_iid/approval_rules/:approval_rule_id
```
......@@ -931,7 +931,7 @@ These are system generated rules.
You can delete merge request approval rules using the following endpoint:
```
```plaintext
DELETE /projects/:id/merge_requests/:merge_request_iid/approval_rules/:approval_rule_id
```
......@@ -953,7 +953,7 @@ These are system generated rules.
If you are allowed to, you can approve a merge request using the following
endpoint:
```
```plaintext
POST /projects/:id/merge_requests/:merge_request_iid/approve
```
......@@ -1016,7 +1016,7 @@ does not match, the response code will be `409`.
If you did approve a merge request, you can unapprove it using the following
endpoint:
```
```plaintext
POST /projects/:id/merge_requests/:merge_request_iid/unapprove
```
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment