[V3] OpenAPI 3.0 Preview #660
Closed
Conversation
This file contains 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
4 tasks
|
Visit the preview URL for this PR (updated for commit 3675c4e): https://docusaurus-openapi-36b86--pr660-xyj5psbp.web.app (expires Fri, 02 Aug 2024 13:56:06 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
|
Thanks for putting this together, excited to get our docs up and running with Docusaurus 3 👍
|
* add negative look behind to exclude colon delimited path segments (#663) * use SCHEMA_TYPE to distinguish request/response to support readOnly/writeOnly properties (#665) * Improve support for handling multipart form data (#666) * use pdfblock to test multipart form data * switch back to cors proxy * add handler for generic key-value payload * debug response content type * refactor to download media and file content types * switch back to petstore
* Introduce clean function for escaping headers and descriptions * Remove escape from codeblocks * Add typing to sidebar generation * Update Docusaurus dependencies in packages * Use improved TypeScript support of Docusaurus for demo * Update tests
* TypeScript refactor ApiCodeBlock * TypeScript refactor Tabs * TypeScript refactor components * Add inline code to clean method * TypeScript refactor items * Test ClientWidth arrows, update flatten TabChildren * Lint fixes * Fix Sidebar prettier and typing issues * Fix greedy curly bracket escape
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
packages/docusaurus-plugin-openapi-docs/src/markdown/utils.ts
Dismissed
Show dismissed
Hide dismissed
|
@sserrata can we include Callbacks Support in V3, please? |
https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/700/files |
* Add Callbacks support (#691) * add support to callbacks in openapi specs * set package manager in package json * implement operations as tabs within request panel * render callbacks below Request and Responses * remove unwanted files * rename create file * restore json settings * convert OperationTabs to typescript * fix linter * fix warning on lint order
* Make docs plugin configurable * Update README
Co-authored-by: Tatiana <[email protected]>
* update vscode * ensure cleanup of sidebars.ts and switch to recursive delete schemas
* add option to disable frontmatter openapi snippet compression * disable compression for petstore * explicitly check for true * handle both compressed and uncompression api prop
|
Hi, there @sserrata! I know the question of "when v3" has been asked and answered, so I won't bug you with the same thing. I do, however, want to drop some more detailed questions:
|
Signed-off-by: Alex Ivanov <[email protected]>
* introduce x-tags onto SchemaObject type, and revise sidebar types A few of the types in the `sidebars/index.ts` page have been changed to allow for more proper typing of both api items and schema items. * add schemas with x-tags into the tag category sidebar slice * add schemas with x-tags even if showSchemas is not true * add a badge and some styling for schema sidebar labels * add some test coverage * add some x-tags documentation to `sidebars.md` * update documentation on styling sidebar items * include schema-only tags, just like operation-only ones * add the pet x-tag to the Cat schema for demo purposes * filter out x-tagged schemas from the "Schemas" category they'll already be displayed elsewhere
* add missing export type declaration for setAccept * fix setAccept import * uncomment setAccept and setContentType actions
* Rearrange Schemas category from each tagGroup category This commit takes the first tagGroup category's Schema category, adds it to the very end of the sidebarSlice, and deletes the Schema category from all the (now sibling) tagGroup categories. Closes #836 * add a schema object to the Restaurant specfile * show schemas in the restaurant demo API * add documentation to sidebars.md
* support downloadUrl for versions * demonstrate version downloadUrl
* add function for merging user and predefined language sets * cleanup and implement new merge function * cleanup console logging * formatting cleanup * allow overriding variants * limit python variants to requests * reorder language tabs
* use abs url path for petstore download url * update isURL function to support abs path * formatting * revert isURL and support relative or abs downloadUrl path
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Long-standing PR for v3.0.0 release.
Preview: https://docusaurus-openapi-36b86--pr660-xyj5psbp.web.app/
Motivation and Context
Provides support for Docusaurus v3.0.0