Page MenuHomeSoftware Heritage

api/identifiers: Add /known/ endpoint documentation
ClosedPublic

Authored by anlambert on Feb 12 2020, 6:02 PM.

Details

Summary

First draft of new /known/ endpoint documentation (will need some updates once D2661 gets landed).

Depends on D2682

Diff Detail

Repository
rDWAPPS Web applications
Branch
document-known-endpoint
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 10585
Build 15804: Cypress tests for swh-web diffsJenkins
Build 15803: tox-on-jenkinsJenkins
Build 15802: arc lint + arc unit

Event Timeline

vlorentz added a subscriber: vlorentz.
vlorentz added inline comments.
swh/web/api/views/identifiers.py
79–80
94

was provided

95

Why noqa? The line "Allowed HTTP Methods" can't have a newline?

This revision now requires changes to proceed.Feb 14 2020, 10:30 AM
swh/web/api/views/identifiers.py
79–80

ack

94

ack

95

It could if I update the parsing code in apidoc, let me check if it easily feasible

swh/web/api/views/identifiers.py
95

Yes it is. This HTTP methods parsing stuff is only needed for the HTML documentation displayed on the archive website and is not related to sphinxcontrib-httpdomain.

So I will update the code to extract the HTTP methods from the docstrings and then remove the **Allowed HTTP Methods:** lines

Update: Address vlorentz comments

swh/web/api/views/identifiers.py
95
This revision is now accepted and ready to land.Feb 14 2020, 6:39 PM

Rebase and document that the input pids array length can not exceed 1000