HomeSoftware Heritage

api: Remove duplicated documentation and improve it

Description

api: Remove duplicated documentation and improve it

Previously, the web api was documented in two different places:

  • directly in the Python code through the use of decorators from the apidoc module
  • in swh-web sphinx documentation, using the httpdomain extension

The documentation now only relies on using sphinx and httpdomain.
Sphinx documentation have been spread in relevant docstrings of the api
endpoints implementation and the apidoc module now parse those docstrings
to extract the relevant info (endpoint description, url arguments and
query parameters, desciption of the json object returned, ...).

Web api HTML interface has also been improved in terms of semantics
and design.

Closes T1105

Details

Provenance
anlambertAuthored on Feb 20 2018, 12:12 PM
anlambertPushed on Jun 21 2018, 4:52 PM
Parents
rDWAPPS0e9c50fd9d9e: swh.web.common.utils: Adapt persistent identifier computations
Branches
Unknown
Tags
Unknown
Tasks
T1105: Web app: Remove duplicated api documentation