Page MenuHomeSoftware Heritage
Differential D2668

api/identifiers: Add /known/ endpoint documentation
ClosedPublic
Actions

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

Details

Reviewers
vlorentz
Group Reviewers
Reviewers
Commits
rDWAPPSefbd2216e052: api/identifiers: Add /known/ endpoint documentation
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 10617
Build 15883: Cypress tests for swh-web diffsJenkins
Build 15882: tox-on-jenkinsJenkins
Build 15881: arc lint + arc unit

Event Timeline

anlambert created this revision.Feb 12 2020, 6:02 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptFeb 12 2020, 6:02 PM
swh-public-ci added a comment.Feb 12 2020, 6:29 PM

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

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

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

Harbormaster completed remote builds in B10585: Diff 9524.Feb 12 2020, 6:57 PM
vlorentz requested changes to this revision.Feb 14 2020, 10:30 AM
vlorentz added a subscriber: vlorentz.
vlorentz added inline comments.
swh/web/api/views/identifiers.py
91–96

could be a link to https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html

108

was provided

109

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
anlambert updated this revision to Diff 9547.Feb 14 2020, 5:12 PM

Rebase

anlambert added inline comments.Feb 14 2020, 5:18 PM
swh/web/api/views/identifiers.py
91–96

ack

108

ack

109

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

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

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

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

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

swh-public-ci added a comment.Feb 14 2020, 6:01 PM

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

Harbormaster completed remote builds in B10608: Diff 9547.Feb 14 2020, 6:01 PM
anlambert updated this revision to Diff 9556.Feb 14 2020, 6:33 PM

Update: Address vlorentz comments

Harbormaster failed remote builds in B10617: Diff 9556!Feb 14 2020, 6:33 PM
anlambert edited the summary of this revision. (Show Details)Feb 14 2020, 6:34 PM
anlambert added a parent revision: D2679: apidoc: Simplify HTTP methods extraction from docstrings.
anlambert removed a parent revision: D2667: apidoc: Add bullet list support in input/output data documentation.
anlambert added inline comments.Feb 14 2020, 6:36 PM
swh/web/api/views/identifiers.py
109

D2679

vlorentz accepted this revision.Feb 14 2020, 6:39 PM
This revision is now accepted and ready to land.Feb 14 2020, 6:39 PM
swh-public-ci added a comment.Feb 14 2020, 6:42 PM

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

swh-public-ci added a comment.Feb 14 2020, 6:50 PM

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

swh-public-ci added a comment.Feb 14 2020, 6:53 PM

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

swh-public-ci added a comment.Feb 14 2020, 7:09 PM

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

Harbormaster completed remote builds in B10617: Diff 9556.Feb 14 2020, 7:09 PM
anlambert updated this revision to Diff 9566.Feb 17 2020, 12:15 PM

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

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

Build has FAILED

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

Harbormaster failed remote builds in B10627: Diff 9566!Feb 17 2020, 12:45 PM
swh-public-ci added a comment.Feb 17 2020, 1:20 PM

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

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

Update: Fix test

swh-public-ci added a comment.Feb 17 2020, 1:42 PM

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

swh-public-ci added a comment.Feb 17 2020, 1:48 PM

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

Harbormaster completed remote builds in B10629: Diff 9568.Feb 17 2020, 1:48 PM
anlambert updated this revision to Diff 9576.Feb 17 2020, 4:22 PM

Rebase

Harbormaster failed remote builds in B10637: Diff 9576!Feb 17 2020, 4:22 PM
anlambert edited the summary of this revision. (Show Details)Feb 17 2020, 4:22 PM
anlambert added a parent revision: D2682: apidoc: Fix and improve rst links parsing.
anlambert removed a parent revision: D2679: apidoc: Simplify HTTP methods extraction from docstrings.
swh-public-ci added a comment.Feb 17 2020, 4:49 PM

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

swh-public-ci added a comment.Feb 17 2020, 4:58 PM

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

swh-public-ci added a comment.Feb 17 2020, 5:25 PM

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

swh-public-ci added a comment.Feb 17 2020, 5:39 PM

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

Harbormaster completed remote builds in B10637: Diff 9576.Feb 17 2020, 5:39 PM
Closed by commit rDWAPPSefbd2216e052: api/identifiers: Add /known/ endpoint 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: rDWAPPSefbd2216e052: api/identifiers: Add /known/ endpoint documentation.

Revision Contents
Changeset List

PathSize
docs/
3 lines
swh/
web/
api/
views/
39 lines
tests/
api/
views/
4 lines

Diff 9556

View Options

docs/uri-scheme-api-identifiers.rst

Loading...
View Options

swh/web/api/views/identifiers.py

Loading...
View Options

swh/web/tests/api/views/test_identifiers.py

Loading...
About · Developer information · Legal