Skip to content

Commit

Permalink
Update docs for triggering a build
Browse files Browse the repository at this point in the history
  • Loading branch information
humitos committed Mar 12, 2019
1 parent 77df448 commit fda8d8f
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions docs/api/v3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ Build details

.. sourcecode:: bash

$ curl https://readthedocs.org/api/v3/projects/pip/builds/8592686/?include_config=true
$ curl https://readthedocs.org/api/v3/projects/pip/builds/8592686/?expand=config

**Example response**:

Expand Down Expand Up @@ -484,23 +484,30 @@ Build triggering

.. http:post:: /api/v3/projects/(string:project_slug)/builds/
Trigger a new build for this project.
Trigger a new build for the default version of this project.

**Example request**:
**Example response**:

.. sourcecode:: json
`See Build details <#build-details>`_

{
"version": "latest",
}
:requestheader Authorization: required token to authenticate.

:statuscode 202: Accepted
:statuscode 400: Some field is invalid
:statuscode 401: Not valid permissions


.. http:post:: /api/v3/projects/(string:project_slug)/versions/(string:version_slug)/builds/
Trigger a new build for the ``version_slug`` version of this project.

**Example response**:

`See Build details <#build-details>`_

:requestheader Authorization: required token to authenticate.

:statuscode 201: Created sucessfully
:statuscode 202: Accepted
:statuscode 400: Some field is invalid
:statuscode 401: Not valid permissions

Expand Down

0 comments on commit fda8d8f

Please sign in to comment.