Skip to content

Update doccs version detail (api v3) #6259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 9, 2019
Merged

Update doccs version detail (api v3) #6259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#

# You can set these variables from the command line.
SPHINXOPTS = -W --keep-going
SPHINXOPTS = -W
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make htmlive doesn't work with that option.

SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
Expand Down
21 changes: 6 additions & 15 deletions docs/api/v3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,6 @@ Version detail
"ref": "19.0.2",
"built": true,
"active": true,
"uploaded": true,
"type": "tag",
"last_build": "{BUILD}",
"downloads": {
Expand All @@ -349,21 +348,13 @@ Version detail
}
}

:>json integer id: ID for this version on the database
:>json string slug: The slug for this version
:>json string verbose_name: The name of the version
:>json string identifier: A version control identifier for this version (eg. the commit hash of the tag)
:>json string ref: tag or branch pointed by this version (available only when version is ``stable`` or ``latest``)
:>json string built: Whether this version has been built
:>json string active: Whether this version is active
:>json string type: The type of this version (typically "tag" or "branch")
:>json string last_build: Build object representing the last build of this version
:>json array downloads: URLs to downloads of this version's documentation
:>json string ref: the version slug where the ``stable`` version points to.
``null`` when it's not the stable version.
:>json boolean built: the version has at least one successful build.

:requestheader Authorization: token to authenticate.

:statuscode 200: Success
:statuscode 404: There is no ``Version`` with this slug for this project
:query string expand: allows to add/expand some extra fields in the response.
Allowed values are ``last_build`` and ``last_build.config``.
Multiple fields can be passed separated by commas.


Version update
Expand Down