Page MenuHomeSoftware Heritage
Differential D2666

apidoc: Add support for request data documentation
ClosedPublic
Actions

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

Details

Reviewers
vlorentz
Group Reviewers
Reviewers
Commits
rDWAPPSafbbc2380ccb: apidoc: Add support for request data documentation
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
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

anlambert created this revision.Feb 12 2020, 5:59 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptFeb 12 2020, 5:59 PM
anlambert added a child revision: D2667: apidoc: Add bullet list support in input/output data documentation.Feb 12 2020, 6:00 PM
swh-public-ci added a comment.Feb 12 2020, 6:13 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/934/ for more details.

swh-public-ci added a comment.Feb 12 2020, 6:28 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/543/ for more details.

Harbormaster completed remote builds in B10583: Diff 9522.Feb 12 2020, 6:28 PM
vlorentz accepted this revision.Feb 14 2020, 10:20 AM
This revision is now accepted and ready to land.Feb 14 2020, 10:20 AM
anlambert updated this revision to Diff 9531.Feb 14 2020, 2:08 PM

Rebase

anlambert updated this revision to Diff 9532.Feb 14 2020, 2:09 PM

Rebase on the correct branch

anlambert updated this revision to Diff 9533.Feb 14 2020, 2:21 PM

Fix tests

swh-public-ci added a comment.Feb 14 2020, 2:22 PM

Build has FAILED

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/939/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/939/console

Harbormaster failed remote builds in B10592: Diff 9531!Feb 14 2020, 2:22 PM
swh-public-ci added a comment.Feb 14 2020, 2:29 PM

Build has FAILED

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/940/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/940/console

Harbormaster failed remote builds in B10593: Diff 9532!Feb 14 2020, 2:29 PM
swh-public-ci added a comment.Feb 14 2020, 2:37 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/941/ for more details.

swh-public-ci added a comment.Feb 14 2020, 2:37 PM

Build has FAILED

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/548/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/548/console

anlambert updated this revision to Diff 9535.Feb 14 2020, 2:38 PM

Rebase

swh-public-ci added a comment.Feb 14 2020, 2:54 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/943/ for more details.

swh-public-ci added a comment.Feb 14 2020, 2:55 PM

Build has FAILED

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/549/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/549/console

swh-public-ci added a comment.Feb 14 2020, 3:10 PM

Build has FAILED

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/550/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/550/console

Harbormaster failed remote builds in B10594: Diff 9533!Feb 14 2020, 3:10 PM
swh-public-ci added a comment.Feb 14 2020, 3:41 PM

Build has FAILED

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/552/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/552/console

Harbormaster failed remote builds in B10596: Diff 9535!Feb 14 2020, 3:41 PM
anlambert updated this revision to Diff 9544.Feb 14 2020, 4:23 PM

Rebase

swh-public-ci added a comment.Feb 14 2020, 4:46 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/948/ for more details.

swh-public-ci added a comment.Feb 14 2020, 5:16 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/557/ for more details.

Harbormaster completed remote builds in B10605: Diff 9544.Feb 14 2020, 5:16 PM
anlambert updated this revision to Diff 9563.Feb 17 2020, 12:06 PM

Rebase

swh-public-ci added a comment.Feb 17 2020, 12:21 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/958/ for more details.

swh-public-ci added a comment.Feb 17 2020, 12:36 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/567/ for more details.

Harbormaster completed remote builds in B10624: Diff 9563.Feb 17 2020, 12:36 PM
Closed by commit rDWAPPSafbbc2380ccb: apidoc: Add support for request data documentation (authored by anlambert). · Explain WhyFeb 18 2020, 11:38 AM
This revision was automatically updated to reflect the committed changes.
anlambert added a commit: rDWAPPSafbbc2380ccb: apidoc: Add support for request data documentation.

Revision Contents
Changeset List

PathSize
swh/
web/
api/
43 lines
templates/
api/
37 lines
tests/
api/
110 lines

Diff 9589

View Options

swh/web/api/apidoc.py

Loading...
View Options

swh/web/templates/api/apidoc.html

Loading...
View Options

swh/web/tests/api/test_apidoc.py

Loading...
About · Developer information · Legal