Skip to content

docs(api): put APIs at menu root, clarify nesting (v6.2 backport of #4708) - #4712

Open
JorisHeadease wants to merge 1 commit into
V6.2from
V6_2/backport-4708-api-reference-readability
Open

JorisHeadease wants to merge 1 commit into
V6.2from
V6_2/backport-4708-api-reference-readability

Conversation

@JorisHeadease

Copy link
Copy Markdown
Contributor

Backport of #4708 to V6.2.

Same change as on master: the cherry-pick applies without conflicts, as V6.2's API reference files were identical to master's.

Verified on this branch: the merge script combines the specs into 85 operations, with the active APIs at the menu root and the deprecated ones under Deprecated, and links to tags and operations unchanged. The breadcrumb bar stays hidden, nested objects and expanded responses get the tint while collapsed panels don't, and Sphinx builds without warnings, as before.

Addresses the feedback on nuts-foundation/nuts-knooppunt#651. The deprecated APIs nest under a Deprecated tag through the OpenAPI 3.2 tag parent instead of x-tagGroups, so the other APIs sit at the menu root. Custom CSS gives nested objects and expanded responses a stronger line and a tint per level, and hides Scalar's breadcrumb bar, which shows an unrelated trail outside the deprecated APIs once a tag has a parent.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants