Page MenuHomeSoftware Heritage

doc: improve the doc of API endpoints
ClosedPublic

Authored by douardda on Nov 6 2020, 10:58 AM.

Details

Summary

make usage of the sphinx-httpdomain extension according to its
documenation.

Depends on D4426.

Diff Detail

Repository
rDDEP Push deposit
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Build is green

Patch application report for D4427 (id=15683)

Could not rebase; Attempt merge onto 0f4ec31168...

Updating 0f4ec311..61653ddf
Fast-forward
 docs/endpoints/collection.rst       | 116 +++++++++++++++++++-----------------
 docs/endpoints/content.rst          |  65 +++++++++++++++++++-
 docs/endpoints/service-document.rst |  80 +++++++++++++++----------
 docs/endpoints/status.rst           |  63 +++++++++++---------
 docs/endpoints/update-media.rst     |  16 ++---
 docs/endpoints/update-metadata.rst  |  10 ++--
 docs/index.rst                      |   2 +-
 docs/spec-api.rst                   |  29 ++++-----
 docs/specs/{specs.rst => index.rst} |   0
 9 files changed, 237 insertions(+), 144 deletions(-)
 rename docs/specs/{specs.rst => index.rst} (100%)
Changes applied before test
commit 61653ddfc7c38bd4130374a6b6472f55f358138a
Author: David Douard <david.douard@sdfa3.org>
Date:   Thu Nov 5 16:16:07 2020 +0100

    doc: improve the doc of API endpoints
    
    make usage of the sphinx-httpdomain extension according to its
    documenation.

commit 1736371f2c6da9713e4f815da99cd3cd624fdaad
Author: David Douard <david.douard@sdfa3.org>
Date:   Thu Nov 5 14:21:40 2020 +0100

    doc: rename docs/specs/specs.rst as docs/specs/index.rst
    
    for the sake of clarity.

See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/281/ for more details.

This revision is now accepted and ready to land.Nov 6 2020, 11:22 AM
This revision was automatically updated to reflect the committed changes.