feat: Implement schema pages behind a config option showSchemas#736
Merged
sserrata merged 2 commits intoPaloAltoNetworks:mainfrom Mar 12, 2024
Merged
feat: Implement schema pages behind a config option showSchemas#736sserrata merged 2 commits intoPaloAltoNetworks:mainfrom
showSchemas#736sserrata merged 2 commits intoPaloAltoNetworks:mainfrom
Conversation
|
Visit the preview URL for this PR (updated for commit cb4e7d2): https://docusaurus-openapi-36b86--pr736-x972kop3.web.app (expires Thu, 11 Apr 2024 13:20:32 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
sserrata
approved these changes
Mar 12, 2024
Member
sserrata
left a comment
There was a problem hiding this comment.
Tested with a couple of product API specs and it LGTM! Thanks!
sserrata
pushed a commit
that referenced
this pull request
Mar 15, 2024
* feat: Implement schema pages behind a config option `showSchemas` * Add `showSchemas` to petstore demo
sserrata
added a commit
that referenced
this pull request
Mar 15, 2024
* feat: implement x-tagGroup feature (#737) * impement redoc's x-tagGroup feature * merge main * update documentation * fix filtered tags by group * remove tracked .idea files * add option to readme * merge main * fix lint * revert yarn.lock and linter * cleanup missing types, dup imports and add restaurant example * fix: Guard only undefined and empty strings (#725) * Conditional display of header Request (#719) Co-authored-by: Christian A. Mathiesen <christian@zaveit.no> * update lock file * feat: Implement schema pages behind a config option `showSchemas` (#736) * feat: Implement schema pages behind a config option `showSchemas` * Add `showSchemas` to petstore demo * address linter errors * enable schemas for petstore * update lock file * add missing heading import * address linter errors --------- Co-authored-by: Çağrı S <bencagri@users.noreply.github.com> Co-authored-by: Florian Garcia <garcia.florian.perso@gmail.com> Co-authored-by: chranmat <cam@mathix.net> Co-authored-by: Christian A. Mathiesen <christian@zaveit.no> Co-authored-by: Marc L <littlemarc2020@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds support for schema/model definition pages which are generated when
showSchemasis set totrue.The out-of-the-box behavior is kept the same - no schema pages.
Motivation and Context
I am a SE over from Canopy Connect, and we are looking to take our documentation to the next level. After some considerations (Readme - current, Docusaurus, Mintlify, Starlight Astro) I believe Docusaurus to be one of the best options, expect for the fact that this openapi plugin doesn't have schema pages, which we require. I'm hoping to help push this along so we can make our switch to Docusaurus.
#713
#225
How Has This Been Tested?
Toggling
showSchemason various configs in demo, runningyarn clean-apiandyarn watch:demo.When
showSchemasistrue, a new sidebar category is added: "Schemas". Within this category should exist any schemas defined incomponents.schemasof the openapi spec.Screenshots (if appropriate)
Sidebar:
Petstore User schema example:
Video click through:
Schema.pages.click.through.trimmed-4.mp4
Types of changes
showSchemasmust be set to trueChecklist