Skip to content

Fix JSON response

What does this MR do?

Fix response sample for POST /runners. It seems the id is a number, not a string.

POST http://gitlab.example.com/api/v4/runners
Private-Token: gkndLG-tzRsemb4myqa9
Content-Type: application/json; charset=utf-8

{
  "description": "test",
  "token": "1yCWaimpn3nqSKUKGjio"
}
201 Created
Server: nginx
Date: Fri, 08 Jan 2021 21:03:38 GMT
Connection: keep-alive
Cache-Control: must-revalidate, max-age=0, private
ETag: W/"a2feb14ffa6fccb3b71a144625961761"
Vary: Origin
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-Gitlab-Feature-Category: continuous_integration
X-Request-ID: 01EVHWZPB4SJPF74JJXVYMSTZ5
X-Runtime: 0.115645
Strict-Transport-Security: max-age=31536000
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json
Content-Length: 39

{
  "id": 4,
  "token": "VaDmXsWxyceGvaqKzchy"
}

Related issues

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports