Page MenuHomeSoftware Heritage

apidoc: Add support for request data documentation
ClosedPublic

Authored by anlambert on Feb 12 2020, 5:59 PM.

Details

Summary

Some new api endpoints require to send JSON data in HTTP requests but it was currently
not handled by the apidoc module.

So handle corresponding httpdomain directives in our custom rst nodes visitor.

Also add support for documenting JSON array of non object type as httpdomain does
not offer any directive for that type.

And yes I know the code in that module is awful but until we start implementing API v2,
we are stucked with it to display the HTML documentation.

Depends on D2665

Diff Detail

Repository
rDWAPPS Web applications
Branch
apidoc-request-data
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 10592
Build 15819: Cypress tests for swh-web diffsJenkins
Build 15818: tox-on-jenkinsJenkins
Build 15817: arc lint + arc unit

Event Timeline

This revision is now accepted and ready to land.Feb 14 2020, 10:20 AM

Rebase on the correct branch