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] Respect readOnly/writeOnly and improve body sample #203

Merged
merged 7 commits into from
Aug 11, 2022

Conversation

sserrata
Copy link
Member

Description

This PR primarily addresses #194 but also introduces improvements to how the sample body is created.

Note: the decision was made to split createSchemaDetails into createRequestSchema and createResponseSchema to have tighter control over selective rendering.

Motivation and Context

As the issue points out, we should respect readOnly and writeOnly when determining which items to render for request and response schemas and body sample.

How Has This Been Tested?

Tested with Petstore API.

Screenshots (if appropriate)

See deploy preview.

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

github-actions bot commented Aug 11, 2022

Size Change: -17.6 kB (0%)

Total Size: 3.59 MB

Filename Size Change
demo/build/assets/js/0d832478.********.js 25.8 kB -832 B (-3%)
demo/build/assets/js/12693653.********.js 25.1 kB -832 B (-3%)
demo/build/assets/js/3e0d14e9.********.js 22.7 kB -555 B (-2%)
demo/build/assets/js/40a238b6.********.js 25.1 kB -832 B (-3%)
demo/build/assets/js/4964e910.********.js 24.6 kB -832 B (-3%)
demo/build/assets/js/49bd3d39.********.js 16.2 kB -386 B (-2%)
demo/build/assets/js/69a61f78.********.js 25.1 kB -832 B (-3%)
demo/build/assets/js/7ca3ae45.********.js 16.2 kB -386 B (-2%)
demo/build/assets/js/7ed7dafe.********.js 25.7 kB -832 B (-3%)
demo/build/assets/js/86c45737.********.js 23.1 kB -555 B (-2%)
demo/build/assets/js/8961c7a6.********.js 22.7 kB -555 B (-2%)
demo/build/assets/js/94589c06.********.js 17.6 kB -968 B (-5%)
demo/build/assets/js/97810f3c.********.js 24.7 kB -832 B (-3%)
demo/build/assets/js/9b5caaf3.********.js 25 kB -832 B (-3%)
demo/build/assets/js/aa2f1ec7.********.js 23.2 kB -555 B (-2%)
demo/build/assets/js/ab6072f2.********.js 25.1 kB -832 B (-3%)
demo/build/assets/js/b4ebd305.********.js 16 kB -386 B (-2%)
demo/build/assets/js/c65697f5.********.js 25.7 kB -832 B (-3%)
demo/build/assets/js/cf07762b.********.js 23.3 kB -555 B (-2%)
demo/build/assets/js/dd696920.********.js 24.6 kB -832 B (-3%)
demo/build/assets/js/e015ccf9.********.js 25 kB -832 B (-3%)
demo/build/assets/js/f212caf7.********.js 22.6 kB -555 B (-2%)
demo/build/assets/js/f84e10c2.********.js 17.8 kB -968 B (-5%)
demo/build/assets/js/fe97f0d1.********.js 17.7 kB -968 B (-5%)
ℹ️ View Unchanged
Filename Size Change
demo/.docusaurus/globalData.json 19.1 kB 0 B
demo/build/assets/css/styles.********.css 97.7 kB 0 B
demo/build/assets/js/006e727e.********.js 14.1 kB -2 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 -2 B (0%)
demo/build/assets/js/09e07b87.********.js 2.97 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 -20 B (0%)
demo/build/assets/js/18c41134.********.js 12.7 kB 0 B
demo/build/assets/js/19d75775.********.js 8.46 kB -2 B (0%)
demo/build/assets/js/1a8cc2a6.********.js 11.5 kB -2 B (0%)
demo/build/assets/js/1be78505.********.js 10.3 kB 0 B
demo/build/assets/js/1c54f54e.********.js 10.4 kB -20 B (0%)
demo/build/assets/js/1e4232ab.********.js 3.15 kB 0 B
demo/build/assets/js/1e6c5cae.********.js 33 kB -2 B (0%)
demo/build/assets/js/1e6ff21d.********.js 10.3 kB -20 B (0%)
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/3946f914.********.js 33 kB -2 B (0%)
demo/build/assets/js/39d00f16.********.js 9.87 kB 0 B
demo/build/assets/js/41cd56a1.********.js 10.1 kB -2 B (0%)
demo/build/assets/js/423cd203.********.js 14.2 kB -2 B (0%)
demo/build/assets/js/466ac800.********.js 41.9 kB -2 B (0%)
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/4b891ed6.********.js 11.1 kB -2 B (0%)
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/55a6d13f.********.js 14 kB -2 B (0%)
demo/build/assets/js/56717cba.********.js 2.96 kB 0 B
demo/build/assets/js/57f1a671.********.js 11.2 kB -2 B (0%)
demo/build/assets/js/58ff8b1e.********.js 20.9 kB -20 B (0%)
demo/build/assets/js/597ddc40.********.js 10 kB -20 B (0%)
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 -2 B (0%)
demo/build/assets/js/6429.********.js 1.28 MB 0 B
demo/build/assets/js/66c76a57.********.js 33 kB -2 B (0%)
demo/build/assets/js/68b61ac5.********.js 42 kB -2 B (0%)
demo/build/assets/js/73b594ee.********.js 32.9 kB -2 B (0%)
demo/build/assets/js/77264a1a.********.js 32.9 kB -2 B (0%)
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/86b273b1.********.js 9.94 kB -20 B (0%)
demo/build/assets/js/86c346b0.********.js 538 B 0 B
demo/build/assets/js/881db345.********.js 394 B 0 B
demo/build/assets/js/8ab9b16e.********.js 9.62 kB -2 B (0%)
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/91696e06.********.js 33.1 kB -2 B (0%)
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/9c42c0f3.********.js 25.3 kB -2 B (0%)
demo/build/assets/js/a40c6d71.********.js 8.56 kB -2 B (0%)
demo/build/assets/js/a5491aaa.********.js 400 B 0 B
demo/build/assets/js/a6cd895f.********.js 20.8 kB -20 B (0%)
demo/build/assets/js/a728d93a.********.js 9.73 kB -2 B (0%)
demo/build/assets/js/ab09fd5c.********.js 20.9 kB -20 B (0%)
demo/build/assets/js/ae7f40a3.********.js 42.1 kB -2 B (0%)
demo/build/assets/js/b5c059ef.********.js 25.4 kB -2 B (0%)
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/c7a5be9f.********.js 9.95 kB -2 B (0%)
demo/build/assets/js/c7ded1cb.********.js 2.93 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/dff1c289.********.js 3.88 kB 0 B
demo/build/assets/js/e01f8d18.********.js 8.5 kB -2 B (0%)
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/eae14b71.********.js 25.3 kB -2 B (0%)
demo/build/assets/js/eaf4471e.********.js 11.4 kB -2 B (0%)
demo/build/assets/js/ecc39b49.********.js 172 B 0 B
demo/build/assets/js/ee308fa3.********.js 10.1 kB -2 B (0%)
demo/build/assets/js/f4486b6b.********.js 11.6 kB -2 B (0%)
demo/build/assets/js/f55d3e7a.********.js 2.7 kB 0 B
demo/build/assets/js/f65290a6.********.js 9.82 kB -20 B (0%)
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 0830dd3):

https://docusaurus-openapi-36b86--pr203-o39r0rbz.web.app

(expires Sat, 10 Sep 2022 18:12:07 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

@sserrata sserrata merged commit 8c5e49f into main Aug 11, 2022
@sserrata sserrata deleted the selective-rendering branch August 11, 2022 18:18
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.

1 participant