[V3] OpenAPI 3.0 Preview #660

sserrata · 2023-11-17T17:07:40Z

Description

Long-standing PR for v3.0.0 release.

Preview: https://docusaurus-openapi-36b86--pr660-a47qtiik.web.app/

Motivation and Context

Provides support for Docusaurus v3.0.0

Note: this branch automatically deploys canary releases and will be periodically used to deploy 3.0.0-beta.x releases that can you be used in your project(s). Please check README/homepage/announcements for the latest beta release.

…scription

github-actions · 2023-11-17T17:12:47Z

Visit the preview URL for this PR (updated for commit 3056787):

https://docusaurus-openapi-36b86--pr660-xyj5psbp.web.app

_{(expires Thu, 18 Jul 2024 15:49:21 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

jcwillox · 2023-11-18T12:43:45Z

Thanks for putting this together, excited to get our docs up and running with Docusaurus 3 👍
I've just tested it on around 300 endpoints and had no issues with mdx or running it with docusaurus 3, everything appears to work correctly except the JSON syntax highlighting is not working for the response examples and the actual response body after using the send request button, the issue is also present in your preview deployment. For us, it's also not working in the editable request body, although we also had that specific issue in v2, so likely unrelated.

* 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

packages/docusaurus-plugin-openapi-docs/src/markdown/utils.ts

lucasassisrosa · 2024-01-16T13:58:54Z

@sserrata can we include Callbacks Support in V3, please?

lucasassisrosa · 2024-01-18T14:59:54Z

@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

…support to params (#754) * avoid guarding 0 values * support deprecated params * update utils tests to should guard false * always render required when true and apply strikethrough when deprecated

mason-at-pieces · 2024-03-20T20:51:36Z

Looking forward to testing the new parsers 🔥

)

…765) * ensure qualifiers are rendered for polymorphic properties * update createSchema test

* ensure merged schema is used to generate schema name and qualifier * combine schema title and type when both are present * cleanup formatting

* Prepare release v3.0.0-beta.9 * fix formatting issue

* upgrade lerna to 8.1.2 * update lockfile

* Make docs plugin configurable * Update README

Co-authored-by: Tatiana <tatiana.perry@coalese.io>

* update vscode * ensure cleanup of sidebars.ts and switch to recursive delete schemas

…nent (#796)

* add option to disable frontmatter openapi snippet compression * disable compression for petstore * explicitly check for true * handle both compressed and uncompression api prop

ElliotFriend · 2024-05-30T19:47:39Z

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:

Is there a public roadmap or checklist of what remains to be done? Are any of the GH issues targeted for v3 or anything? Any major blockers at the moment? As you said, it's a "moving target," but I'm curious what work still lies ahead. Because...
I'd love to help! What can I do to pitch in? We use the plugin for a few different software packages in our docs site, and we're (maybe too?) eager to migrate off of docusaurus v2. I'd be happy to contribute some time and effort to help out with the work. I've gotten pretty ok at the inner-workings of docusaurus, so I hope I might be able to lend a hand.

~~P.S. The most recent commit, 23c8c01, doesn't seem to have generated a canary/beta release, from what I can tell.~~ (Edit: Scratch that, it probably doesn't really have any need to be a released version, since it's just a change in the demo?)

…ed correctly (#831)

Signed-off-by: Alex Ivanov <entense@yandex.ru>

* 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

sserrata added 3 commits November 17, 2023 10:26

initial refactor

e8bd71e

convert contact info to markdown, update lessThan regex and escape de…

0428f74

…scription

re-enable all API docs

f0cd4cd

sserrata added the v3.0.0 label Nov 17, 2023

sserrata mentioned this pull request Nov 17, 2023

Format JSX with newlines and indentation #648

Closed

4 tasks

bump version to 3.0.0-beta.0

6ce2141

sserrata and others added 6 commits November 17, 2023 12:20

support v3.0.0 canary releases

30c1626

update createSchema snapshot

f1ad0e3

update v2.0.0 refs to v3.0.0

dfe758a

Update deploy-preview.yml

08be0d0

Prepare release v3.0.0-beta.1 (#661)

4486cbb

Update release-beta.yaml

9641610

szczys mentioned this pull request Nov 28, 2023

Fix swagger css golioth/docs#306

Merged

jcwillox mentioned this pull request Dec 1, 2023

Ensure Docusaurus v3 (MDX v3) compatibility #654

Closed

sserrata and others added 6 commits December 1, 2023 10:41

Prepare release v3.0.0-beta.2 (#668)

9e57319

install prettier plugin (#681)

dfcdb04

upgrade prettier

315ef31

Prepare release v3.0.0-beta.3 (#682)

4836267

karl-cardenas-coding mentioned this pull request Dec 21, 2023

Upgrade to Docusarus v3 spectrocloud/librarium#1935

Closed

github-advanced-security bot found potential problems Jan 5, 2024

View reviewed changes

packages/docusaurus-plugin-openapi-docs/src/markdown/utils.ts Dismissed Show dismissed Hide dismissed

Prepare release v3.0.0-beta.4 (#688)

1207af7

JoshC8C7 had a problem deploying to default January 11, 2024 14:38 — with GitHub Actions Failure

Upgrade OpenAPI parsers (#749)

c3d0f72

ElliotFriend mentioned this pull request Mar 19, 2024

Upgrade to Docusaurus v3 stellar/stellar-docs#355

Open

sserrata and others added 2 commits March 20, 2024 13:09

[bugfix] Ensure 0 and false are guarded correctly and add deprecated …

45cb59e

…support to params (#754) * avoid guarding 0 values * support deprecated params * update utils tests to should guard false * always render required when true and apply strikethrough when deprecated

fix import/eslint errors

acc2a75

sserrata force-pushed the v3.0.0 branch from 07ffc24 to acc2a75 Compare March 20, 2024 17:13

Prepare release v3.0.0-beta.7 (#757)

effd6b9

sserrata and others added 18 commits March 21, 2024 11:18

ensure resize observer is calculated once per frame to avoid loops (#763

748e42c

)

uncomment line preventing grouping by operation tags (#764)

f28711e

Ensure qualifiers are rendered for polymorphic/primitive properties (#…

d7bbe20

…765) * ensure qualifiers are rendered for polymorphic properties * update createSchema test

Fix allOf schema qualifier and type (#766)

850b5d0

* ensure merged schema is used to generate schema name and qualifier * combine schema title and type when both are present * cleanup formatting

Prepare release v3.0.0-beta.8 (#767)

5877a91

ensure correct eval of required properties with allOf (#771)

530d2c8

Prepare release v3.0.0-beta.9 (#773)

ab5f392

* Prepare release v3.0.0-beta.9 * fix formatting issue

upgrade lerna to 8.1.2 (#778)

80c6130

* upgrade lerna to 8.1.2 * update lockfile

use inline to remove p tag (#779)

3b24626

Prepare release v3.0.0-beta.10 (#780)

82d70be

Remove scrollbar width for Tab components (#785)

e00226f

Allow custom plugin to render (#784)

72e585f

* Make docs plugin configurable * Update README

changed theme and plugin to headings (#786)

253e455

Co-authored-by: Tatiana <tatiana.perry@coalese.io>

Ensure sidebars.ts and schemas are properly cleaned (#817)

7a4e93f

* update vscode * ensure cleanup of sidebars.ts and switch to recursive delete schemas

preventing to send form onClick left/right arrows in SchemaTabs compo…

f621777

…nent (#796)

Add option to disable frontmatter api prop compression (#800)

9732053

* add option to disable frontmatter openapi snippet compression * disable compression for petstore * explicitly check for true * handle both compressed and uncompression api prop

add missing types and cast ref to LegacyRef (#818)

58fa26b

upgrade demo to docusaurus 3.3.2 (#822)

23c8c01

htmlin and others added 4 commits June 17, 2024 13:45

fix: markdown table within the description attribute cannot be render…

a8cffdf

…ed correctly (#831)

Update index.tsx (#839)

cbca95e

fix col row padding footer&pagination (#810)

10cda3c

Signed-off-by: Alex Ivanov <entense@yandex.ru>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[V3] OpenAPI 3.0 Preview #660

[V3] OpenAPI 3.0 Preview #660

sserrata commented Nov 17, 2023 •

edited

github-actions bot commented Nov 17, 2023 •

edited

jcwillox commented Nov 18, 2023

lucasassisrosa commented Jan 16, 2024 •

edited

lucasassisrosa commented Jan 18, 2024

mason-at-pieces commented Mar 20, 2024

ElliotFriend commented May 30, 2024 •

edited

[V3] OpenAPI 3.0 Preview #660

Are you sure you want to change the base?

[V3] OpenAPI 3.0 Preview #660

Conversation

sserrata commented Nov 17, 2023 • edited

Description

Motivation and Context

github-actions bot commented Nov 17, 2023 • edited

jcwillox commented Nov 18, 2023

lucasassisrosa commented Jan 16, 2024 • edited

lucasassisrosa commented Jan 18, 2024

mason-at-pieces commented Mar 20, 2024

ElliotFriend commented May 30, 2024 • edited

sserrata commented Nov 17, 2023 •

edited

github-actions bot commented Nov 17, 2023 •

edited

lucasassisrosa commented Jan 16, 2024 •

edited

ElliotFriend commented May 30, 2024 •

edited