Skip to content

Commit 2adee18

Browse files
committed
Use query attribute to (not)show the config object on build details
1 parent b2e5ae5 commit 2adee18

File tree

1 file changed

+3
-45
lines changed

1 file changed

+3
-45
lines changed

docs/api/v3.rst

+3-45
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ Build details
344344

345345
.. sourcecode:: bash
346346

347-
$ curl https://readthedocs.org/api/v3/projects/pip/builds/8592686/
347+
$ curl https://readthedocs.org/api/v3/projects/pip/builds/8592686/?include_config=true
348348

349349
**Example response**:
350350

@@ -420,6 +420,8 @@ Build details
420420
:>json string builder: The hostname server that built the docs
421421
:>json string cold_storage: Whether the build was removed from database and stored externally
422422

423+
:query boolean include_config: whether or not include the configs used for this build. Default is ``false``
424+
423425
:requestheader Authorization: optional token to authenticate.
424426

425427
:statuscode 200: Success
@@ -500,50 +502,6 @@ Build triggering
500502
:statuscode 401: Not valid permissions
501503

502504

503-
Build status
504-
++++++++++++
505-
506-
507-
.. http:get:: /api/v3/projects/(str:project_slug)/builds/(int:build_id)/status/
508-
509-
Retrieve status details of a single build.
510-
511-
**Example request**:
512-
513-
.. sourcecode:: bash
514-
515-
$ curl https://readthedocs.org/api/v3/projects/pip/builds/8592686/status/
516-
517-
**Example response**:
518-
519-
.. sourcecode:: json
520-
521-
{
522-
"id": 8592686,
523-
"version": "latest",
524-
"project": "pip",
525-
"created": "2018-06-19T15:15:59+00:00",
526-
"finished": null,
527-
"duration": null,
528-
"state": {
529-
"code": "triggered",
530-
"name": "Triggered"
531-
},
532-
"success": null,
533-
"error": null,
534-
"commit": "6f808d743fd6f6907ad3e2e969c88a549e76db30",
535-
"builder": "build03",
536-
"links": {
537-
"self": "/api/v3/projects/pip/builds/8592686/",
538-
"project": "/api/v3/projects/pip/",
539-
"version": "/api/v3/projects/pip/versions/latest/",
540-
"commands": "/api/v3/projects/pip/builds/8592686/commands/"
541-
}
542-
}
543-
544-
:requestheader Authorization: optional token to authenticate.
545-
546-
547505
Build commands listing
548506
++++++++++++++++++++++
549507

0 commit comments

Comments
 (0)