Skip to content

[DOC-560] OpenAPI fields anchor links #218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Sep 21, 2023
Merged

[DOC-560] OpenAPI fields anchor links #218

merged 9 commits into from
Sep 21, 2023

Conversation

dandimeo
Copy link
Contributor

@dandimeo dandimeo commented Sep 18, 2023

Description

  • OpenAPI fields are searchable within browser search; if fields are hidden, they will be automatically expanded
  • Every field has an anchor link and generates an URL fragment within the URL, so that it can be easily shared as a link

Upstream PRs

  • 3.10:
  • 3.11:
  • 3.12:

@arangodb-docs-automation
Copy link
Contributor

Deploy Preview Available Via
https://deploy-preview-218--docs-hugo.netlify.app

@dandimeo dandimeo marked this pull request as draft September 18, 2023 13:36
@dandimeo dandimeo marked this pull request as ready for review September 19, 2023 11:26
Copy link
Contributor

@Simran-B Simran-B left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you use in-page search, options expand if they contain a match - this is great - but there is a slight problem: the icon that indicates the expand/collapsed state is not updated and then shows the opposite state (it's like > even though in-page search expanded it, then you click it to collapse and it becomes v as if it was expanded)

There are some anchor collisions, e.g. the collection path parameter and request body parameter here: https://deploy-preview-218--docs-hugo.netlify.app/3.11/develop/http/graphs/named-graphs/#replace-an-edge-definition

Otherwise, everything seems to work nicely.

Copy link
Contributor

@Simran-B Simran-B left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works great!

@nerpaula nerpaula merged commit 6f9ca59 into main Sep 21, 2023
@nerpaula nerpaula deleted the DOC-560 branch September 21, 2023 08:57
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.

3 participants