Skip to content

Commit 8d0489a

Browse files
committed
Update doccs version detail (api v3)
Some fields are not used. I'm brining some changes from readthedocs#6169 to avoid merge conflicts.
1 parent b6a532b commit 8d0489a

File tree

2 files changed

+7
-16
lines changed

2 files changed

+7
-16
lines changed

docs/Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#
33

44
# You can set these variables from the command line.
5-
SPHINXOPTS = -W --keep-going
5+
SPHINXOPTS = -W
66
SPHINXBUILD = sphinx-build
77
PAPER =
88
BUILDDIR = _build

docs/api/v3.rst

+6-15
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,6 @@ Version detail
330330
"ref": "19.0.2",
331331
"built": true,
332332
"active": true,
333-
"uploaded": true,
334333
"type": "tag",
335334
"last_build": "{BUILD}",
336335
"downloads": {
@@ -349,21 +348,13 @@ Version detail
349348
}
350349
}
351350

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

363-
:requestheader Authorization: token to authenticate.
364-
365-
:statuscode 200: Success
366-
:statuscode 404: There is no ``Version`` with this slug for this project
355+
:query string expand: allows to add/expand some extra fields in the response.
356+
Allowed values are ``last_build`` and ``last_build.config``.
357+
Multiple fields can be passed separated by commas.
367358

368359

369360
Version update

0 commit comments

Comments
 (0)