Paths

Table of Contentst

Split endpoint table into categories
ClosedPublic
Actions

Authored by vlorentz on Aug 18 2022, 5:59 PM.

Details

Reviewers

ardumont
anlambert

Group Reviewers

Reviewers

Commits

rDWAPPSeb2cda51cab4: Split endpoint table into categories

Summary

It makes it easier to find related endpoints than alphabetically
sorting URLs.

This removes datatables enhancements on this page, as they are longer
relevant for a split table.

Diff Detail

Repository

rDWAPPS Web applications

Branch

master

Lint

No Linters Available

Unit

No Unit Test Coverage

Build Status

Buildable 31000
Build 48491: Phabricator diff pipeline on jenkins	Jenkins console · Jenkins
Build 48490: arc lint + arc unit

Event Timeline

vlorentz created this revision.Aug 18 2022, 5:59 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptAug 18 2022, 5:59 PM

Build is green

Patch application report for D8258 (id=29830)

Rebasing onto d72784ac65...

Current branch diff-target is up to date.

Changes applied before test

commit 0b701d682f25cd0ec28a5d69391da54fffb93cbd
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Aug 18 17:58:30 2022 +0200

    Split endpoint table into categories
    
    It makes it easier to find related endpoints than alphabetically
    sorting URLs.
    
    This removes datatables enhancements on this page, as they are longer
    relevant for a split table.

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

Harbormaster completed remote builds in B30882: Diff 29830.Aug 18 2022, 6:13 PM

vlorentz requested review of this revision.Aug 18 2022, 6:13 PM

That sounds a like a good idea but I'd like to see how that renders first. Can you
please add a screenshot of the result, tia?

added to the diff's description

Looks great, thanks ! I think you could add the following improvements:

Declare the categories using constants in apidoc.py and use them in views implementation
Use keyword parameter when setting category for better readability
Should a category name starts with an uppercase letter ?

added to the diff's description

Thanks!
It's better indeed.

Now @anlambert suggested a couple of nice improvments.
And i'll let him finish the review.

Cheers,

vlorentz edited the summary of this revision. (Show Details)Aug 23 2022, 2:34 PM

In D8258#215279, @anlambert wrote:

Looks great, thanks ! I think you could add the following improvements:

Declare the categories using constants in apidoc.py and use them in views implementation

done using Literal instead

Use keyword parameter when setting category for better readability

Should a category name starts with an uppercase letter ?

Done

Looks good to me, thanks !

This revision is now accepted and ready to land.Aug 23 2022, 2:38 PM

This revision was landed with ongoing or failed builds.Aug 23 2022, 2:42 PM

Closed by commit rDWAPPSeb2cda51cab4: Split endpoint table into categories (authored by vlorentz). · Explain Why

This revision was automatically updated to reflect the committed changes.

vlorentz added a commit: rDWAPPSeb2cda51cab4: Split endpoint table into categories.

Build is green

Patch application report for D8258 (id=29948)

Rebasing onto cb2f35021f...

Current branch diff-target is up to date.

Changes applied before test

commit eb2cda51cab46253613741b4f39d2148be2f00af
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Aug 18 17:58:30 2022 +0200

    Split endpoint table into categories
    
    It makes it easier to find related endpoints than alphabetically
    sorting URLs.
    
    This removes datatables enhancements on this page, as they are longer
    relevant for a split table.

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

Harbormaster completed remote builds in B31000: Diff 29948.Aug 23 2022, 2:50 PM