Page MenuHomeSoftware Heritage

docs: Add /raw/(swhid)/ endpoint in Web API documentation
ClosedPublic

Authored by anlambert on Thu, May 5, 4:48 PM.

Details

Summary

We miss to add that new Web API endpoint in sphinx doc.

Also rename identifiers to swhids in rst filenames and reword some
section titles.

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

Build is green

Patch application report for D7746 (id=28015)

Rebasing onto 468dda170e...

Current branch diff-target is up to date.
Changes applied before test
commit e92dc8b59f4806f12f5ceac6682059237ab5d012
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Thu May 5 16:45:21 2022 +0200

    docs: Add /raw/(swhid)/ endpoint in Web API documentation
    
    Also rename identifiers to swhids in rst filenames and reword some
    section titles.

See https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/1779/ for more details.

Should we add redirects for the previous page names?

This revision is now accepted and ready to land.Thu, May 5, 5:14 PM

Should we add redirects for the previous page names?

Ah right, I forgot about that, will push a new diff in swh-docs then.

docs/uri-scheme-swhids.rst
1–2

I think you want the W capitalized too if the D is?

docs/uri-scheme-swhids.rst
1–2

Indeed, thanks for spotting.

Capitalize W to match SWHIDs acronym.

Build is green

Patch application report for D7746 (id=28017)

Rebasing onto 468dda170e...

Current branch diff-target is up to date.
Changes applied before test
commit de3cd9d9821a225debffa5587b95fbd208445904
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Thu May 5 16:45:21 2022 +0200

    docs: Add /raw/(swhid)/ endpoint in Web API documentation
    
    Also rename identifiers to swhids in rst filenames and reword some
    section titles.

See https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/1781/ for more details.

Build is green

Patch application report for D7746 (id=28043)

Rebasing onto 55122f0a2e...

Current branch diff-target is up to date.
Changes applied before test
commit 54e679c46104a2ea68229687bd71baee5ec6ae1c
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Thu May 5 16:45:21 2022 +0200

    docs: Add /raw/(swhid)/ endpoint in Web API documentation
    
    Also rename identifiers to swhids in rst filenames and reword some
    section titles.

See https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/1786/ for more details.

Should we add redirects for the previous page names?

Ah right, I forgot about that, will push a new diff in swh-docs then.

I created D7752 to redirect uri-scheme-identifiers generate document to uri-scheme-swhids one.

For uri-scheme-api-identifiers, there is no associated HTML page as the file is included in uri-scheme-api.rst.
In that case, the SWHIDs endpoints doc is referenced by an anchor in the Web API doc: persistent-identifiers that got
renamed to swhids-persistent-identifiers. Unfortunately, that type of redirection is not supported by sphinx-reredirects.

This revision was landed with ongoing or failed builds.Fri, May 6, 1:43 PM
This revision was automatically updated to reflect the committed changes.

Build is green

Patch application report for D7746 (id=28058)

Rebasing onto 55122f0a2e...

Current branch diff-target is up to date.
Changes applied before test
commit 54e679c46104a2ea68229687bd71baee5ec6ae1c
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Thu May 5 16:45:21 2022 +0200

    docs: Add /raw/(swhid)/ endpoint in Web API documentation
    
    Also rename identifiers to swhids in rst filenames and reword some
    section titles.

See https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/1789/ for more details.