Skip to content

docs(api): put APIs at menu root, clarify nesting (v5.4 backport of #4708) - #4713

Open
JorisHeadease wants to merge 1 commit into
V5.4from
V5_4/backport-4708-api-reference-readability
Open

JorisHeadease wants to merge 1 commit into
V5.4from
V5_4/backport-4708-api-reference-readability

Conversation

@JorisHeadease

Copy link
Copy Markdown
Contributor

Backport of #4708 to V5.4.

V5.4 has no deprecated APIs, so its menu had a single "APIs" group. Dropping x-tagGroups moves the APIs to the menu root, and no Deprecated tag or parent is needed. Without nested tags Scalar shows no breadcrumb bar, so the rule that hides it on master is left out. The CSS for nested objects and expanded responses, and defaultOpenFirstTag: false, are the same as on master.

Verified on this branch: the merge script combines the specs into 56 operations, with 13 menu items at the root and links to tags and operations unchanged. Nested objects and expanded responses get the tint while collapsed panels don't, and Sphinx builds with the same 14 warnings as before.

Backport of #4708 to V5.4, adapted because V5.4 has no deprecated APIs: dropping x-tagGroups moves the APIs from the single "APIs" group to the menu root, so no Deprecated tag and no breadcrumb rule are needed. Custom CSS gives nested objects and expanded responses a stronger line and a tint per level, as on master.

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