From 8d0489a4db8304537c394cfda16f4f6d934f317d Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Tue, 8 Oct 2019 14:34:39 -0500 Subject: [PATCH] Update doccs version detail (api v3) Some fields are not used. I'm brining some changes from https://github.com/readthedocs/readthedocs.org/pull/6169 to avoid merge conflicts. --- docs/Makefile | 2 +- docs/api/v3.rst | 21 ++++++--------------- 2 files changed, 7 insertions(+), 16 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 7e97a2c7183..cdb357b38f7 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS = -W --keep-going +SPHINXOPTS = -W SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build diff --git a/docs/api/v3.rst b/docs/api/v3.rst index e4788083fc9..62f778a0a78 100644 --- a/docs/api/v3.rst +++ b/docs/api/v3.rst @@ -330,7 +330,6 @@ Version detail "ref": "19.0.2", "built": true, "active": true, - "uploaded": true, "type": "tag", "last_build": "{BUILD}", "downloads": { @@ -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