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

[Bug] Improve handling of response schemas and examples #208

Merged
merged 6 commits into from
Aug 12, 2022

Conversation

sserrata
Copy link
Member

@sserrata sserrata commented Aug 11, 2022

Description

Addresses issue #205 and is a hotfix for #206. Basically, single response examples should just be converted to a formatted JSON string.

Additional refactoring was done to ensure appropriate hierarchy from status code to content type to schemas and examples.

Motivation and Context

n/a

How Has This Been Tested?

Tested with sample response example.

Screenshots (if appropriate)

Screen Shot 2022-08-11 at 5 18 04 PM

@sserrata sserrata added the bug Something isn't working label Aug 11, 2022
@github-actions
Copy link

github-actions bot commented Aug 11, 2022

Size Change: +11.3 kB (0%)

Total Size: 3.6 MB

Filename Size Change
demo/build/assets/js/006e727e.********.js 13.9 kB +561 B (+4%)
demo/build/assets/js/1a8cc2a6.********.js 11.9 kB +305 B (+3%)
demo/build/assets/js/1e6c5cae.********.js 33.4 kB +411 B (+1%)
demo/build/assets/js/3946f914.********.js 33.4 kB +411 B (+1%)
demo/build/assets/js/423cd203.********.js 13.9 kB +561 B (+4%)
demo/build/assets/js/466ac800.********.js 42.3 kB +411 B (+1%)
demo/build/assets/js/49bd3d39.********.js 16.6 kB +413 B (+3%)
demo/build/assets/js/55a6d13f.********.js 13.8 kB +561 B (+4%)
demo/build/assets/js/58ff8b1e.********.js 21.3 kB +305 B (+1%)
demo/build/assets/js/597ddc40.********.js 10.3 kB +307 B (+3%)
demo/build/assets/js/66c76a57.********.js 33.4 kB +411 B (+1%)
demo/build/assets/js/68b61ac5.********.js 42.4 kB +411 B (+1%)
demo/build/assets/js/73b594ee.********.js 33.3 kB +411 B (+1%)
demo/build/assets/js/77264a1a.********.js 33.3 kB +411 B (+1%)
demo/build/assets/js/7ca3ae45.********.js 16.6 kB +413 B (+3%)
demo/build/assets/js/86b273b1.********.js 10.2 kB +307 B (+3%)
demo/build/assets/js/91696e06.********.js 33.5 kB +411 B (+1%)
demo/build/assets/js/94589c06.********.js 18.4 kB +250 B (+1%)
demo/build/assets/js/9c42c0f3.********.js 25.7 kB +411 B (+2%)
demo/build/assets/js/a6cd895f.********.js 21.1 kB +305 B (+1%)
demo/build/assets/js/ab09fd5c.********.js 21.2 kB +305 B (+1%)
demo/build/assets/js/ae7f40a3.********.js 42.5 kB +411 B (+1%)
demo/build/assets/js/b4ebd305.********.js 16.5 kB +413 B (+3%)
demo/build/assets/js/b5c059ef.********.js 25.8 kB +411 B (+2%)
demo/build/assets/js/eae14b71.********.js 25.7 kB +411 B (+2%)
demo/build/assets/js/eaf4471e.********.js 11.7 kB +305 B (+3%)
demo/build/assets/js/f4486b6b.********.js 11.9 kB +305 B (+3%)
demo/build/assets/js/f65290a6.********.js 10.1 kB +307 B (+3%)
demo/build/assets/js/f84e10c2.********.js 18.6 kB +250 B (+1%)
demo/build/assets/js/fe97f0d1.********.js 18.5 kB +250 B (+1%)
ℹ️ View Unchanged
Filename Size Change
demo/.docusaurus/globalData.json 19.1 kB 0 B
demo/build/assets/css/styles.********.css 97.6 kB -14 B (0%)
demo/build/assets/js/05f64ae1.********.js 2.78 kB 0 B
demo/build/assets/js/06b64fc1.********.js 575 B 0 B
demo/build/assets/js/06e5f0f0.********.js 27.1 kB 0 B
demo/build/assets/js/081bfb0d.********.js 9.8 kB 0 B
demo/build/assets/js/09e07b87.********.js 2.97 kB 0 B
demo/build/assets/js/0d832478.********.js 25.8 kB 0 B
demo/build/assets/js/12693653.********.js 25.1 kB 0 B
demo/build/assets/js/14eb3368.********.js 9.19 kB 0 B
demo/build/assets/js/1639936b.********.js 4.33 kB 0 B
demo/build/assets/js/16577668.********.js 387 B 0 B
demo/build/assets/js/177e86db.********.js 10.2 kB 0 B
demo/build/assets/js/18c41134.********.js 12.7 kB 0 B
demo/build/assets/js/19d75775.********.js 8.46 kB 0 B
demo/build/assets/js/1be78505.********.js 10.3 kB 0 B
demo/build/assets/js/1c54f54e.********.js 10.4 kB 0 B
demo/build/assets/js/1e4232ab.********.js 3.15 kB 0 B
demo/build/assets/js/1e6ff21d.********.js 10.3 kB 0 B
demo/build/assets/js/1f818248.********.js 11.1 kB 0 B
demo/build/assets/js/2c860537.********.js 6.95 kB 0 B
demo/build/assets/js/326c3861.********.js 10 kB 0 B
demo/build/assets/js/3893.********.js 1.07 kB 0 B
demo/build/assets/js/39d00f16.********.js 9.87 kB 0 B
demo/build/assets/js/3e0d14e9.********.js 22.7 kB 0 B
demo/build/assets/js/40a238b6.********.js 25.1 kB 0 B
demo/build/assets/js/41cd56a1.********.js 10.1 kB 0 B
demo/build/assets/js/46afcded.********.js 8.13 kB 0 B
demo/build/assets/js/46e5c6ac.********.js 6.66 kB 0 B
demo/build/assets/js/47abaca6.********.js 2.88 kB 0 B
demo/build/assets/js/4964e910.********.js 24.6 kB 0 B
demo/build/assets/js/4b891ed6.********.js 11.1 kB 0 B
demo/build/assets/js/4c5e977b.********.js 30.9 kB 0 B
demo/build/assets/js/533a09ca.********.js 2.48 kB 0 B
demo/build/assets/js/56717cba.********.js 2.96 kB 0 B
demo/build/assets/js/57f1a671.********.js 11.2 kB 0 B
demo/build/assets/js/5c868d36.********.js 3.24 kB 0 B
demo/build/assets/js/5fb917be.********.js 2.52 kB 0 B
demo/build/assets/js/63fc267d.********.js 11.3 kB 0 B
demo/build/assets/js/6429.********.js 1.28 MB 0 B
demo/build/assets/js/69a61f78.********.js 25.1 kB 0 B
demo/build/assets/js/7ed7dafe.********.js 25.7 kB 0 B
demo/build/assets/js/822bd8ab.********.js 2.87 kB 0 B
demo/build/assets/js/85d3c400.********.js 2.88 kB 0 B
demo/build/assets/js/85ec4403.********.js 4.46 kB 0 B
demo/build/assets/js/86c346b0.********.js 538 B 0 B
demo/build/assets/js/86c45737.********.js 23.1 kB 0 B
demo/build/assets/js/881db345.********.js 394 B 0 B
demo/build/assets/js/8961c7a6.********.js 22.7 kB 0 B
demo/build/assets/js/8ab9b16e.********.js 9.62 kB 0 B
demo/build/assets/js/8d4e78cd.********.js 2.81 kB 0 B
demo/build/assets/js/8f441c78.********.js 9.97 kB 0 B
demo/build/assets/js/93304a97.********.js 4.45 kB 0 B
demo/build/assets/js/935f2afb.********.js 32.2 kB 0 B
demo/build/assets/js/97810f3c.********.js 24.7 kB 0 B
demo/build/assets/js/9b5caaf3.********.js 25 kB 0 B
demo/build/assets/js/a40c6d71.********.js 8.56 kB 0 B
demo/build/assets/js/a5491aaa.********.js 400 B 0 B
demo/build/assets/js/a728d93a.********.js 9.73 kB 0 B
demo/build/assets/js/aa2f1ec7.********.js 23.2 kB 0 B
demo/build/assets/js/ab6072f2.********.js 25.1 kB 0 B
demo/build/assets/js/bead4b8e.********.js 3.03 kB 0 B
demo/build/assets/js/bf271e74.********.js 401 B 0 B
demo/build/assets/js/c65697f5.********.js 25.7 kB 0 B
demo/build/assets/js/c7a5be9f.********.js 9.95 kB 0 B
demo/build/assets/js/c7ded1cb.********.js 2.93 kB 0 B
demo/build/assets/js/cf07762b.********.js 23.3 kB 0 B
demo/build/assets/js/common.********.js 158 kB 0 B
demo/build/assets/js/d63c7029.********.js 2.9 kB 0 B
demo/build/assets/js/dd696920.********.js 24.6 kB 0 B
demo/build/assets/js/dff1c289.********.js 3.88 kB 0 B
demo/build/assets/js/e015ccf9.********.js 25 kB 0 B
demo/build/assets/js/e01f8d18.********.js 8.5 kB 0 B
demo/build/assets/js/e2ce9793.********.js 402 B 0 B
demo/build/assets/js/e44a2883.********.js 4.53 kB 0 B
demo/build/assets/js/e5e5340c.********.js 2.45 kB 0 B
demo/build/assets/js/e8b309fb.********.js 577 B 0 B
demo/build/assets/js/ecc39b49.********.js 172 B 0 B
demo/build/assets/js/ee308fa3.********.js 10.1 kB 0 B
demo/build/assets/js/f212caf7.********.js 22.6 kB 0 B
demo/build/assets/js/f55d3e7a.********.js 2.7 kB 0 B
demo/build/assets/js/f8409a7e.********.js 29 kB 0 B
demo/build/assets/js/main.********.js 396 kB 0 B
demo/build/assets/js/runtime~main.********.js 8.67 kB 0 B
demo/build/index.html 79.9 kB 0 B

compressed-size-action

@github-actions
Copy link

github-actions bot commented Aug 11, 2022

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

https://docusaurus-openapi-36b86--pr208-wbptlyt1.web.app

(expires Sun, 11 Sep 2022 15:32:00 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

@sserrata sserrata changed the title [Bug] Handle examples as array and example as JSON [Bug] Improve handling of response schemas and examples Aug 12, 2022
@sserrata sserrata merged commit 6d8955c into main Aug 12, 2022
@sserrata sserrata deleted the response-schemas branch August 12, 2022 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant