Page MenuHomeSoftware Heritage

apidoc: Fix some issues regarding generated documentation links
ClosedPublic

Authored by anlambert on Oct 31 2022, 2:46 PM.

Details

Summary

Previous URLs targetting endpoints documentation were in the form
/1/<endpoint_route> while they should have been in the form
/api/1/<endpoint_route> so fix them and add redirections from old
URLs for backward compatibility.

Breadcrumbs located in the top left part of Web API endpoint doc
could contain links to non existent endpoints so ensure to remove
those and render spans instead.

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 has FAILED

Patch application report for D8795 (id=31696)

Rebasing onto 94a28741b6...

Current branch diff-target is up to date.
Changes applied before test
commit 024da72220d443cd5e4841aea1983b230af0d102
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Mon Oct 31 14:39:41 2022 +0100

    apidoc: Fix some issues regarding generated documentation links
    
    Previous URLs targetting endpoints documentation were in the form
    /1/<endpoint_route> while they should have been in the form
    /api/1/<endpoint_route> so fix them and add redirections from old
    URLs for backward compatibility.
    
    Breadcrumbs located in the top left part of Web API endpoint doc
    could contain links to non existent endpoints so ensure to remove
    those and render spans instead.

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

Harbormaster returned this revision to the author for changes because remote builds failed.Oct 31 2022, 2:56 PM
Harbormaster failed remote builds in B32648: Diff 31696!

Build has FAILED

Patch application report for D8795 (id=31696)

Rebasing onto 94a28741b6...

Current branch diff-target is up to date.
Changes applied before test
commit 024da72220d443cd5e4841aea1983b230af0d102
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Mon Oct 31 14:39:41 2022 +0100

    apidoc: Fix some issues regarding generated documentation links
    
    Previous URLs targetting endpoints documentation were in the form
    /1/<endpoint_route> while they should have been in the form
    /api/1/<endpoint_route> so fix them and add redirections from old
    URLs for backward compatibility.
    
    Breadcrumbs located in the top left part of Web API endpoint doc
    could contain links to non existent endpoints so ensure to remove
    those and render spans instead.

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

Build has FAILED

Patch application report for D8795 (id=31696)

Rebasing onto 94a28741b6...

Current branch diff-target is up to date.
Changes applied before test
commit 024da72220d443cd5e4841aea1983b230af0d102
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Mon Oct 31 14:39:41 2022 +0100

    apidoc: Fix some issues regarding generated documentation links
    
    Previous URLs targetting endpoints documentation were in the form
    /1/<endpoint_route> while they should have been in the form
    /api/1/<endpoint_route> so fix them and add redirections from old
    URLs for backward compatibility.
    
    Breadcrumbs located in the top left part of Web API endpoint doc
    could contain links to non existent endpoints so ensure to remove
    those and render spans instead.

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

Build has FAILED

Patch application report for D8795 (id=31696)

Rebasing onto 94a28741b6...

Current branch diff-target is up to date.
Changes applied before test
commit 024da72220d443cd5e4841aea1983b230af0d102
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Mon Oct 31 14:39:41 2022 +0100

    apidoc: Fix some issues regarding generated documentation links
    
    Previous URLs targetting endpoints documentation were in the form
    /1/<endpoint_route> while they should have been in the form
    /api/1/<endpoint_route> so fix them and add redirections from old
    URLs for backward compatibility.
    
    Breadcrumbs located in the top left part of Web API endpoint doc
    could contain links to non existent endpoints so ensure to remove
    those and render spans instead.

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

Build is green

Patch application report for D8795 (id=31696)

Rebasing onto 94a28741b6...

Current branch diff-target is up to date.
Changes applied before test
commit 024da72220d443cd5e4841aea1983b230af0d102
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Mon Oct 31 14:39:41 2022 +0100

    apidoc: Fix some issues regarding generated documentation links
    
    Previous URLs targetting endpoints documentation were in the form
    /1/<endpoint_route> while they should have been in the form
    /api/1/<endpoint_route> so fix them and add redirections from old
    URLs for backward compatibility.
    
    Breadcrumbs located in the top left part of Web API endpoint doc
    could contain links to non existent endpoints so ensure to remove
    those and render spans instead.

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

This revision is now accepted and ready to land.Oct 31 2022, 5:12 PM