Page MenuHomeSoftware Heritage

api/identifiers: Add /known/ endpoint documentation
ClosedPublic

Authored by anlambert on Wed, Feb 12, 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
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.Wed, Feb 12, 6:02 PM
vlorentz requested changes to this revision.Fri, Feb 14, 10:30 AM
vlorentz added a subscriber: vlorentz.
vlorentz added inline comments.
swh/web/api/views/identifiers.py
92–99
112

was provided

113

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

This revision now requires changes to proceed.Fri, Feb 14, 10:30 AM
anlambert added inline comments.Fri, Feb 14, 5:18 PM
swh/web/api/views/identifiers.py
92–99

ack

112

ack

113

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

anlambert added inline comments.Fri, Feb 14, 5:44 PM
swh/web/api/views/identifiers.py
113

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

anlambert updated this revision to Diff 9556.Fri, Feb 14, 6:33 PM

Update: Address vlorentz comments

anlambert added inline comments.Fri, Feb 14, 6:36 PM
swh/web/api/views/identifiers.py
113
vlorentz accepted this revision.Fri, Feb 14, 6:39 PM
This revision is now accepted and ready to land.Fri, Feb 14, 6:39 PM
anlambert updated this revision to Diff 9566.Mon, Feb 17, 12:15 PM

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

anlambert updated this revision to Diff 9568.Mon, Feb 17, 1:33 PM

Update: Fix test