Skip to content
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

[V2] OpenAPI 2.0 Preview #439

Closed
wants to merge 91 commits into from
Closed

[V2] OpenAPI 2.0 Preview #439

wants to merge 91 commits into from

Conversation

@blindaa121 blindaa121 self-assigned this Feb 15, 2023
@github-actions
Copy link

github-actions bot commented Feb 15, 2023

Size Change: +17.1 kB (0%)

Total Size: 6.28 MB

Filename Size Change
demo/.docusaurus/globalData.json 18.9 kB -348 B (-2%)
demo/build/assets/css/styles.********.css 107 kB -1.98 kB (-2%)
demo/build/assets/js/006e727e.********.js 15.7 kB +348 B (+2%)
demo/build/assets/js/06e5f0f0.********.js 27.6 kB +206 B (+1%)
demo/build/assets/js/081bfb0d.********.js 10.2 kB +118 B (+1%)
demo/build/assets/js/0d832478.********.js 28.9 kB +249 B (+1%)
demo/build/assets/js/12693653.********.js 28.3 kB +121 B (0%)
demo/build/assets/js/177e86db.********.js 12 kB +36 B (0%)
demo/build/assets/js/19d75775.********.js 9.86 kB -51 B (-1%)
demo/build/assets/js/1a4e3797.********.js 78.6 kB +1.02 kB (+1%)
demo/build/assets/js/1a8cc2a6.********.js 13.5 kB +278 B (+2%)
demo/build/assets/js/1be78505.********.js 11.8 kB +1.27 kB (+12%) ⚠️
demo/build/assets/js/1c54f54e.********.js 11 kB +76 B (+1%)
demo/build/assets/js/1e6c5cae.********.js 38.3 kB +328 B (+1%)
demo/build/assets/js/1e6ff21d.********.js 12 kB +76 B (+1%)
demo/build/assets/js/1f818248.********.js 12.3 kB +86 B (+1%)
demo/build/assets/js/2bb7a9e5.********.js 21.7 kB +181 B (+1%)
demo/build/assets/js/2c860537.********.js 7.47 kB +138 B (+2%)
demo/build/assets/js/3720c009.********.js 1.93 kB +484 B (+34%) 🚨
demo/build/assets/js/3946f914.********.js 37 kB +324 B (+1%)
demo/build/assets/js/3e0d14e9.********.js 25.4 kB +245 B (+1%)
demo/build/assets/js/40a238b6.********.js 28.3 kB +123 B (0%)
demo/build/assets/js/41cd56a1.********.js 11.5 kB +146 B (+1%)
demo/build/assets/js/423cd203.********.js 14.6 kB +348 B (+2%)
demo/build/assets/js/466ac800.********.js 46.8 kB +462 B (+1%)
demo/build/assets/js/4964e910.********.js 26.5 kB +204 B (+1%)
demo/build/assets/js/49bd3d39.********.js 18.2 kB +250 B (+1%)
demo/build/assets/js/4b891ed6.********.js 12.5 kB +51 B (0%)
demo/build/assets/js/4c5e977b.********.js 43.1 kB -303 B (-1%)
demo/build/assets/js/55a6d13f.********.js 15.6 kB +308 B (+2%)
demo/build/assets/js/57f1a671.********.js 12.6 kB +91 B (+1%)
demo/build/assets/js/58ff8b1e.********.js 21.1 kB +193 B (+1%)
demo/build/assets/js/597ddc40.********.js 10.7 kB +111 B (+1%)
demo/build/assets/js/5fb917be.********.js 2.62 kB +54 B (+2%)
demo/build/assets/js/63fc267d.********.js 11.5 kB +91 B (+1%)
demo/build/assets/js/66c76a57.********.js 38.5 kB +284 B (+1%)
demo/build/assets/js/6842.********.js 0 B -3.2 MB (removed) 🏆
demo/build/assets/js/68b61ac5.********.js 48.1 kB +422 B (+1%)
demo/build/assets/js/69a61f78.********.js 27.1 kB +123 B (0%)
demo/build/assets/js/73b594ee.********.js 38.2 kB +288 B (+1%)
demo/build/assets/js/77264a1a.********.js 36.9 kB +328 B (+1%)
demo/build/assets/js/785615ec.********.js 21.6 kB +141 B (+1%)
demo/build/assets/js/7ca3ae45.********.js 19.3 kB +250 B (+1%)
demo/build/assets/js/7ed7dafe.********.js 28.9 kB +209 B (+1%)
demo/build/assets/js/85ec4403.********.js 4.73 kB +63 B (+1%)
demo/build/assets/js/86b273b1.********.js 11.8 kB +111 B (+1%)
demo/build/assets/js/86c45737.********.js 27.8 kB +194 B (+1%)
demo/build/assets/js/8961c7a6.********.js 27 kB +245 B (+1%)
demo/build/assets/js/8ab9b16e.********.js 11.2 kB +78 B (+1%)
demo/build/assets/js/91696e06.********.js 38.5 kB +324 B (+1%)
demo/build/assets/js/935f2afb.********.js 34 kB -79 B (0%)
demo/build/assets/js/94589c06.********.js 22.5 kB +337 B (+2%)
demo/build/assets/js/97810f3c.********.js 27.8 kB +204 B (+1%)
demo/build/assets/js/9b5caaf3.********.js 28.2 kB +81 B (0%)
demo/build/assets/js/9c42c0f3.********.js 37.1 kB +297 B (+1%)
demo/build/assets/js/a5491aaa.********.js 0 B -400 B (removed) 🏆
demo/build/assets/js/a6cd895f.********.js 22.1 kB +153 B (+1%)
demo/build/assets/js/a728d93a.********.js 11.3 kB +118 B (+1%)
demo/build/assets/js/aa2f1ec7.********.js 26 kB +234 B (+1%)
demo/build/assets/js/ab09fd5c.********.js 22.1 kB +193 B (+1%)
demo/build/assets/js/ab6072f2.********.js 27.1 kB +121 B (0%)
demo/build/assets/js/ae7f40a3.********.js 48.1 kB +462 B (+1%)
demo/build/assets/js/b4ebd305.********.js 19.2 kB +210 B (+1%)
demo/build/assets/js/b5c059ef.********.js 37.2 kB +337 B (+1%)
demo/build/assets/js/bf271e74.********.js 0 B -401 B (removed) 🏆
demo/build/assets/js/c65697f5.********.js 27.7 kB +249 B (+1%)
demo/build/assets/js/c7a5be9f.********.js 11.4 kB +106 B (+1%)
demo/build/assets/js/cf07762b.********.js 27.8 kB +234 B (+1%)
demo/build/assets/js/common.********.js 381 kB -7.86 kB (-2%)
demo/build/assets/js/dd696920.********.js 27.7 kB +164 B (+1%)
demo/build/assets/js/df203c0f.********.js 2.88 kB +1.07 kB (+59%) 🆘
demo/build/assets/js/e015ccf9.********.js 28.2 kB +83 B (0%)
demo/build/assets/js/e5e5340c.********.js 2.53 kB +54 B (+2%)
demo/build/assets/js/eae14b71.********.js 35.8 kB +337 B (+1%)
demo/build/assets/js/eaf4471e.********.js 13.4 kB +238 B (+2%)
demo/build/assets/js/ee308fa3.********.js 10.4 kB +146 B (+1%)
demo/build/assets/js/f212caf7.********.js 27 kB +205 B (+1%)
demo/build/assets/js/f4486b6b.********.js 12.4 kB +278 B (+2%)
demo/build/assets/js/f65290a6.********.js 11.7 kB +71 B (+1%)
demo/build/assets/js/f8409a7e.********.js 35.6 kB +400 B (+1%)
demo/build/assets/js/f84e10c2.********.js 20.7 kB +377 B (+2%)
demo/build/assets/js/fcd67c8d.********.js 20.5 kB +181 B (+1%)
demo/build/assets/js/fe97f0d1.********.js 22.6 kB +377 B (+2%)
demo/build/assets/js/main.********.js 474 kB +1.12 kB (0%)
demo/build/assets/js/runtime~main.********.js 9.05 kB -96 B (-1%)
demo/build/index.html 91.6 kB +1.46 kB (+2%)
demo/build/assets/js/9242.********.js 3.21 MB +3.21 MB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
demo/build/assets/js/05f64ae1.********.js 2.81 kB 0 B
demo/build/assets/js/06b64fc1.********.js 575 B 0 B
demo/build/assets/js/09e07b87.********.js 2.97 kB 0 B
demo/build/assets/js/14eb3368.********.js 9.26 kB +4 B (0%)
demo/build/assets/js/1639936b.********.js 5.3 kB +9 B (0%)
demo/build/assets/js/16577668.********.js 387 B 0 B
demo/build/assets/js/3136173c.********.js 361 B 0 B
demo/build/assets/js/326c3861.********.js 11.2 kB +2 B (0%)
demo/build/assets/js/3893.********.js 1.07 kB 0 B
demo/build/assets/js/39d00f16.********.js 13.3 kB +2 B (0%)
demo/build/assets/js/4261.********.js 463 B 0 B
demo/build/assets/js/4670.********.js 104 B 0 B
demo/build/assets/js/46afcded.********.js 8.21 kB 0 B
demo/build/assets/js/46e5c6ac.********.js 6.86 kB 0 B
demo/build/assets/js/47abaca6.********.js 2.88 kB 0 B
demo/build/assets/js/4935.********.js 1.05 kB 0 B
demo/build/assets/js/4b901b1a.********.js 350 B 0 B
demo/build/assets/js/55960ee5.********.js 383 B 0 B
demo/build/assets/js/56717cba.********.js 2.97 kB 0 B
demo/build/assets/js/6a105426.********.js 354 B 0 B
demo/build/assets/js/8003.********.js 5.45 kB 0 B
demo/build/assets/js/85d3c400.********.js 2.9 kB 0 B
demo/build/assets/js/86c346b0.********.js 538 B 0 B
demo/build/assets/js/8777.********.js 76.5 kB 0 B
demo/build/assets/js/881db345.********.js 394 B 0 B
demo/build/assets/js/8d4e78cd.********.js 2.83 kB 0 B
demo/build/assets/js/8f36b2a3.********.js 172 B 0 B
demo/build/assets/js/8f441c78.********.js 13.2 kB +2 B (0%)
demo/build/assets/js/9127.********.js 104 B 0 B
demo/build/assets/js/93304a97.********.js 5.42 kB +2 B (0%)
demo/build/assets/js/967247e2.********.js 11.8 kB 0 B
demo/build/assets/js/a40c6d71.********.js 8.76 kB -11 B (0%)
demo/build/assets/js/a476e24e.********.js 344 B 0 B
demo/build/assets/js/b89b49f4.********.js 6.12 kB +12 B (0%)
demo/build/assets/js/bead4b8e.********.js 3.02 kB 0 B
demo/build/assets/js/c5644638.********.js 337 B 0 B
demo/build/assets/js/c7ded1cb.********.js 2.95 kB 0 B
demo/build/assets/js/cef3f2e2.********.js 5.8 kB 0 B
demo/build/assets/js/d63c7029.********.js 2.92 kB 0 B
demo/build/assets/js/e01f8d18.********.js 9.83 kB -11 B (0%)
demo/build/assets/js/e2ce9793.********.js 397 B 0 B
demo/build/assets/js/e8b309fb.********.js 577 B 0 B
demo/build/assets/js/ecc39b49.********.js 172 B 0 B

compressed-size-action

@github-actions
Copy link

github-actions bot commented Feb 15, 2023

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

https://docusaurus-openapi-36b86--pr439-hycqr78u.web.app

(expires Sun, 10 Dec 2023 19:36:26 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

@blindaa121 blindaa121 changed the title [v2] OpenAPI 2.0 Preview [V2] OpenAPI 2.0 Preview Feb 15, 2023
@sserrata sserrata force-pushed the v2.0.0 branch 5 times, most recently from 90f63b2 to 02a57da Compare February 16, 2023 22:12
blindaa121 and others added 16 commits February 21, 2023 12:29
…nel (#429)

* Add v2 announcement bar

* Remove MethodEndpoint from ApiDemoPanel

* Move MethodEndpoint into api page

* Add newline underneath deprecation notice

* Fix linting issues

* Render MethodEndpoint directly below title

* Resolve merge conflict

* Use width:fit-content for method endpoint

* Add server url to method endpoint

* Fix linting issues

* Add max-width to prevent overflow

* BrowserOnly wrapper test for method endpoint

* Fix linting issues

* Add server variables support

* Refactor server url render with BrowserOnly

* Move serverValue and serverUrlWithVariables to MethodEndpoint component level
* Default to any if no header schema/type exists

* Default to any if no param schema/type exists

* Switch to test spec
* Create info page if title or description exists

* Refactor to support all security types

* Add more example security types for testing

* Render scopes only if length > 0

* Fix formatting

* Fix tab label and header formatting

* Switch to using SchemaTabs

* Use custom class to fit tabs to width
* Add support for vendor extensions

* Add code security for testing

* Revert back to petstore
* Update mustache template

* Add hideSendButton option

* Toggle send button with hide_send_button

* Update frontMatter.hide_send_button if true

* Disable send button for testing

* Unhide send button
…not defined (#455)

* Add preprocessing step to inject title attribute to component schema if none exists

* Add CloudAccounts for testing

* Remove CloudAccounts from demo

* Remove title attribute from components schemas

* Revert back to petstore
* Add support for rendering additionalProperties schemas

* Check for properties, items, anyOf, oneOf, additionalProperties  or allOf before returning createDetailsComponent

* Add check for array
* Eval guard value as double not

* Fix regression bug that always set response primitives required to false
…nippets (#577)

* Rename ApiDemoPanel to ApiExplorer and Curl to CodeSnippets

* Move Modal back into ExpandButton

* Replace openapi-demo class and css selectors with openapi-explorer
@smeng9
Copy link

smeng9 commented Jun 16, 2023

Hi, are there additional child PR's in flight or is the 2.0.0 feature complete?

@sserrata sserrata closed this Jul 24, 2023
@sserrata sserrata reopened this Jul 24, 2023
@sserrata sserrata closed this Aug 24, 2023
@sserrata sserrata reopened this Aug 24, 2023
@sserrata
Copy link
Member

Hi @smeng9, it is considered feature complete as of now.

@smeng9
Copy link

smeng9 commented Aug 25, 2023

Hi @sserrata, It seems nothing is blocking it, do we have a timeline for the stable release of 2.0?

@sserrata
Copy link
Member

@smeng9, hoping to have it rolled out by mid-to-late September, once we have time to focus on this project again. For now, the v2.0.0-beta should be considered "stable enough" for use in production - not anticipating any major breaking changes between now and stable release.

Dr-Electron and others added 16 commits September 11, 2023 09:53
* Unify tab names

* Fix prettier formatting error

* Fix naming in examplebodies

---------

Co-authored-by: Steven Serrata <9343811+sserrata@users.noreply.github.com>
* add compression support to frontmatter api prop

* fix linter errors

* check if api exists before decompressing

* fix linter errors
* add support for anyOf

* Move createResponseSchema and createRequestSchema functions to common module

* Rename createAnyOneOfProperty for consistency

* Fix linter errors

* Use title as tab label and continue creating nodes if properties exist

---------

Co-authored-by: Jordan Stephens <jordan@stephens.io>
* align schema items vertically

* adjust caret height and margin

* fix linter errors

* adjust top alignment for params

* add missing clasname
Co-authored-by: Jan Kukuczka <jan.kukuczka@phonexia.com>
* prepare release v2.0.0-beta.4

* update changelog

* update changelog
* Remove react nextui dependency

* add pure css loading spinner

---------

Co-authored-by: Steven Serrata <sserrata@paloaltonetworks.com>
* Use sass-loader as direct dependency (theme)

* Add yarn lockfile
* Reuse createAnyOneOf while creating a property

`createAnyOneOfProperty` has an incomplete implementation and doesn't display
all possible types at the moment, but only 'object' type.

* Test oneOf tabs showing correct information

* Allow importing dev dependencies in test files

* ignore import/no-extraneous-dependencies

---------

Co-authored-by: Steven Serrata <sserrata@paloaltonetworks.com>
* hide code snippets for webhooks

* hide server path for webhooks

* hide server and send button for webhooks
@IanVS
Copy link
Contributor

IanVS commented Nov 6, 2023

Hi, is there any chance that version 2 of this plugin can be updated to support Docusaurus 3? #654. And so that users can plan for their upgrades, maybe you can give an estimate of when you expect you might have time to finish working on the new version?

Thanks as always!

@sserrata sserrata closed this Nov 13, 2023
@sserrata sserrata deleted the v2.0.0 branch November 13, 2023 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants