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

[Enhancement] Add support for request examples #293

Merged
merged 11 commits into from
Oct 12, 2022
Merged

Conversation

sserrata
Copy link
Member

@sserrata sserrata commented Oct 11, 2022

Description

See #280 for background.

Renders requestBody example(s) inside SchemaTabs. Uses lazy option to prevent all tab items from rendering on first load - instead, the code sample should update each time an example tab is selected.

If you're looking to test use this: https://gist.github.com/biggates/4955d608379a8b1b3224e815c7dd0dc9

@sserrata sserrata added the enhancement New feature or request label Oct 11, 2022
@github-actions
Copy link

github-actions bot commented Oct 11, 2022

Size Change: +1.44 kB (0%)

Total Size: 3.83 MB

Filename Size Change
demo/build/assets/css/styles.********.css 94.5 kB +100 B (0%)
demo/build/assets/js/4c5e977b.********.js 39.8 kB +1.29 kB (+3%)
demo/build/assets/js/common.********.js 159 kB +50 B (0%)
ℹ️ View Unchanged
Filename Size
demo/.docusaurus/globalData.json 19.7 kB
demo/build/assets/js/006e727e.********.js 14 kB
demo/build/assets/js/05f64ae1.********.js 2.83 kB
demo/build/assets/js/06b64fc1.********.js 575 B
demo/build/assets/js/06e5f0f0.********.js 36.9 kB
demo/build/assets/js/081bfb0d.********.js 10 kB
demo/build/assets/js/09e07b87.********.js 3.01 kB
demo/build/assets/js/0d832478.********.js 26.5 kB
demo/build/assets/js/12693653.********.js 25.7 kB
demo/build/assets/js/14eb3368.********.js 9.28 kB
demo/build/assets/js/1639936b.********.js 4.46 kB
demo/build/assets/js/16577668.********.js 387 B
demo/build/assets/js/177e86db.********.js 11.3 kB
demo/build/assets/js/18c41134.********.js 12.7 kB
demo/build/assets/js/19d75775.********.js 9.33 kB
demo/build/assets/js/1a8cc2a6.********.js 12.1 kB
demo/build/assets/js/1be78505.********.js 10.6 kB
demo/build/assets/js/1c54f54e.********.js 10.8 kB
demo/build/assets/js/1e4232ab.********.js 3.16 kB
demo/build/assets/js/1e6c5cae.********.js 34.8 kB
demo/build/assets/js/1e6ff21d.********.js 10.9 kB
demo/build/assets/js/1f818248.********.js 14.8 kB
demo/build/assets/js/2c860537.********.js 7.91 kB
demo/build/assets/js/3136173c.********.js 361 B
demo/build/assets/js/326c3861.********.js 15.7 kB
demo/build/assets/js/3720c009.********.js 1.44 kB
demo/build/assets/js/3893.********.js 1.07 kB
demo/build/assets/js/3946f914.********.js 34.6 kB
demo/build/assets/js/39d00f16.********.js 16.2 kB
demo/build/assets/js/3e0d14e9.********.js 24.3 kB
demo/build/assets/js/40a238b6.********.js 25.7 kB
demo/build/assets/js/41cd56a1.********.js 10.3 kB
demo/build/assets/js/423cd203.********.js 13.9 kB
demo/build/assets/js/4261.********.js 480 B
demo/build/assets/js/466ac800.********.js 43.8 kB
demo/build/assets/js/46afcded.********.js 8.21 kB
demo/build/assets/js/46e5c6ac.********.js 6.86 kB
demo/build/assets/js/47abaca6.********.js 2.92 kB
demo/build/assets/js/4935.********.js 1.05 kB
demo/build/assets/js/4964e910.********.js 25.2 kB
demo/build/assets/js/49bd3d39.********.js 17.5 kB
demo/build/assets/js/4b891ed6.********.js 12 kB
demo/build/assets/js/4b901b1a.********.js 350 B
demo/build/assets/js/533a09ca.********.js 2.49 kB
demo/build/assets/js/55960ee5.********.js 383 B
demo/build/assets/js/55a6d13f.********.js 14.4 kB
demo/build/assets/js/56717cba.********.js 2.98 kB
demo/build/assets/js/57f1a671.********.js 11.4 kB
demo/build/assets/js/58ff8b1e.********.js 21.5 kB
demo/build/assets/js/597ddc40.********.js 10.6 kB
demo/build/assets/js/5c868d36.********.js 3.25 kB
demo/build/assets/js/5fb917be.********.js 2.65 kB
demo/build/assets/js/63fc267d.********.js 11.4 kB
demo/build/assets/js/66c76a57.********.js 35.5 kB
demo/build/assets/js/68b61ac5.********.js 44.6 kB
demo/build/assets/js/69a61f78.********.js 25.5 kB
demo/build/assets/js/6a105426.********.js 354 B
demo/build/assets/js/73b594ee.********.js 35.3 kB
demo/build/assets/js/77264a1a.********.js 34.6 kB
demo/build/assets/js/7ca3ae45.********.js 17.6 kB
demo/build/assets/js/7ed7dafe.********.js 26.9 kB
demo/build/assets/js/8003.********.js 5.45 kB
demo/build/assets/js/822bd8ab.********.js 2.88 kB
demo/build/assets/js/85d3c400.********.js 2.91 kB
demo/build/assets/js/85ec4403.********.js 4.75 kB
demo/build/assets/js/86b273b1.********.js 10.6 kB
demo/build/assets/js/86c346b0.********.js 538 B
demo/build/assets/js/86c45737.********.js 26 kB
demo/build/assets/js/881db345.********.js 394 B
demo/build/assets/js/8961c7a6.********.js 24.9 kB
demo/build/assets/js/8ab9b16e.********.js 10.5 kB
demo/build/assets/js/8d4e78cd.********.js 2.85 kB
demo/build/assets/js/8f441c78.********.js 15.7 kB
demo/build/assets/js/91696e06.********.js 35.1 kB
demo/build/assets/js/93304a97.********.js 4.59 kB
demo/build/assets/js/935f2afb.********.js 44.2 kB
demo/build/assets/js/94589c06.********.js 20.5 kB
demo/build/assets/js/959.********.js 1.34 MB
demo/build/assets/js/967247e2.********.js 8.71 kB
demo/build/assets/js/97810f3c.********.js 25.4 kB
demo/build/assets/js/9b5caaf3.********.js 26.3 kB
demo/build/assets/js/9c42c0f3.********.js 34.6 kB
demo/build/assets/js/a40c6d71.********.js 8.69 kB
demo/build/assets/js/a476e24e.********.js 344 B
demo/build/assets/js/a5491aaa.********.js 400 B
demo/build/assets/js/a6cd895f.********.js 22 kB
demo/build/assets/js/a728d93a.********.js 10.1 kB
demo/build/assets/js/aa2f1ec7.********.js 25 kB
demo/build/assets/js/ab09fd5c.********.js 21.6 kB
demo/build/assets/js/ab6072f2.********.js 25.6 kB
demo/build/assets/js/ae7f40a3.********.js 44.1 kB
demo/build/assets/js/b4ebd305.********.js 18 kB
demo/build/assets/js/b5c059ef.********.js 34.1 kB
demo/build/assets/js/bead4b8e.********.js 3.06 kB
demo/build/assets/js/bf271e74.********.js 401 B
demo/build/assets/js/c5644638.********.js 337 B
demo/build/assets/js/c65697f5.********.js 26.3 kB
demo/build/assets/js/c7a5be9f.********.js 10.7 kB
demo/build/assets/js/c7ded1cb.********.js 2.96 kB
demo/build/assets/js/cef3f2e2.********.js 5.8 kB
demo/build/assets/js/cf07762b.********.js 25.6 kB
demo/build/assets/js/d63c7029.********.js 2.94 kB
demo/build/assets/js/dd696920.********.js 25.8 kB
demo/build/assets/js/df203c0f.********.js 1.8 kB
demo/build/assets/js/dff1c289.********.js 3.9 kB
demo/build/assets/js/e015ccf9.********.js 26.3 kB
demo/build/assets/js/e01f8d18.********.js 8.76 kB
demo/build/assets/js/e2ce9793.********.js 402 B
demo/build/assets/js/e44a2883.********.js 4.54 kB
demo/build/assets/js/e5e5340c.********.js 2.55 kB
demo/build/assets/js/e8b309fb.********.js 577 B
demo/build/assets/js/eae14b71.********.js 33.9 kB
demo/build/assets/js/eaf4471e.********.js 12.6 kB
demo/build/assets/js/ecc39b49.********.js 172 B
demo/build/assets/js/ee308fa3.********.js 10.2 kB
demo/build/assets/js/f212caf7.********.js 25.4 kB
demo/build/assets/js/f4486b6b.********.js 12.1 kB
demo/build/assets/js/f55d3e7a.********.js 2.71 kB
demo/build/assets/js/f65290a6.********.js 11.1 kB
demo/build/assets/js/f8409a7e.********.js 33.8 kB
demo/build/assets/js/f84e10c2.********.js 19.2 kB
demo/build/assets/js/fe97f0d1.********.js 20 kB
demo/build/assets/js/main.********.js 396 kB
demo/build/assets/js/runtime~main.********.js 9.2 kB
demo/build/index.html 88.1 kB

compressed-size-action

@github-actions
Copy link

github-actions bot commented Oct 11, 2022

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

https://docusaurus-openapi-36b86--pr293-uz5mjuyl.web.app

(expires Fri, 11 Nov 2022 17:19:43 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

@sserrata
Copy link
Member Author

Single example:

Screen.Recording.2022-10-11.at.10.59.01.AM.mov

Multiple examples:

Screen.Recording.2022-10-11.at.11.37.59.AM.mov

@sserrata
Copy link
Member Author

Additional testing found that, in some cases, the example value cannot be derived, such as when externalValue is defined.

Spec: https://gist.github.com/biggates/4955d608379a8b1b3224e815c7dd0dc9

Screen.Recording.2022-10-11.at.1.12.11.PM.mov

@sserrata sserrata self-assigned this Oct 11, 2022
@sserrata sserrata merged commit 48a25e2 into main Oct 12, 2022
@sserrata sserrata deleted the request-examples-support branch October 12, 2022 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant