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

[bugfix] Ensure 0 and false are guarded correctly and add deprecated support to params #754

Merged
merged 4 commits into from
Mar 20, 2024

Conversation

sserrata
Copy link
Member

Description

  • refactor guard to allow 0 values
  • update utils tests to ensure false values are properly guarded
  • ensure deprecated is supported for params

Motivation and Context

Addresses regression bug introduced in #725

How Has This Been Tested?

All utils tests passed as expected:

PASS packages/docusaurus-theme-openapi-docs/src/markdown/utils.test.ts

Performed spot check by comparing rendered output of plugin with Redocly

@sserrata sserrata added bug Something isn't working v2.0.0 labels Mar 20, 2024
@sserrata sserrata self-assigned this Mar 20, 2024
Copy link

github-actions bot commented Mar 20, 2024

Size Change: +214 B (0%)

Total Size: 6.34 MB

Filename Size Change
demo/build/assets/js/common.********.js 473 kB +198 B (0%)
ℹ️ View Unchanged
Filename Size Change
demo/.docusaurus/globalData.json 21.5 kB 0 B
demo/build/assets/css/styles.********.css 124 kB 0 B
demo/build/assets/js/006e727e.********.js 11.3 kB 0 B
demo/build/assets/js/04510fe4.********.js 1.75 kB 0 B
demo/build/assets/js/05f64ae1.********.js 2.94 kB 0 B
demo/build/assets/js/06b64fc1.********.js 575 B 0 B
demo/build/assets/js/06e5f0f0.********.js 14.8 kB 0 B
demo/build/assets/js/081bfb0d.********.js 6.92 kB 0 B
demo/build/assets/js/09e07b87.********.js 3.1 kB 0 B
demo/build/assets/js/0d832478.********.js 18.6 kB 0 B
demo/build/assets/js/12693653.********.js 18.2 kB 0 B
demo/build/assets/js/14eb3368.********.js 8.95 kB 0 B
demo/build/assets/js/1639936b.********.js 8.84 kB 0 B
demo/build/assets/js/16577668.********.js 387 B 0 B
demo/build/assets/js/177e86db.********.js 7.95 kB 0 B
demo/build/assets/js/1840.********.js 1.07 kB 0 B
demo/build/assets/js/19d75775.********.js 6.25 kB 0 B
demo/build/assets/js/1a4e3797.********.js 80.4 kB 0 B
demo/build/assets/js/1a8cc2a6.********.js 9.43 kB 0 B
demo/build/assets/js/1be78505.********.js 12.4 kB 0 B
demo/build/assets/js/1c54f54e.********.js 7.5 kB 0 B
demo/build/assets/js/1e6c5cae.********.js 25 kB 0 B
demo/build/assets/js/1e6ff21d.********.js 8 kB 0 B
demo/build/assets/js/1f818248.********.js 8.58 kB 0 B
demo/build/assets/js/2bb7a9e5.********.js 14.4 kB 0 B
demo/build/assets/js/2c860537.********.js 5.86 kB 0 B
demo/build/assets/js/3136173c.********.js 362 B 0 B
demo/build/assets/js/326c3861.********.js 14.7 kB 0 B
demo/build/assets/js/3720c009.********.js 2.01 kB 0 B
demo/build/assets/js/3946f914.********.js 24.1 kB 0 B
demo/build/assets/js/39d00f16.********.js 16.9 kB 0 B
demo/build/assets/js/3e0d14e9.********.js 17.5 kB 0 B
demo/build/assets/js/3fccde26.********.js 2.3 kB 0 B
demo/build/assets/js/40a238b6.********.js 18.2 kB 0 B
demo/build/assets/js/4113f832.********.js 396 B 0 B
demo/build/assets/js/41cd56a1.********.js 7.59 kB 0 B
demo/build/assets/js/423cd203.********.js 10.8 kB 0 B
demo/build/assets/js/466ac800.********.js 28.8 kB 0 B
demo/build/assets/js/46afcded.********.js 8.21 kB 0 B
demo/build/assets/js/46e5c6ac.********.js 7.63 kB 0 B
demo/build/assets/js/47abaca6.********.js 3.01 kB 0 B
demo/build/assets/js/4964e910.********.js 17 kB 0 B
demo/build/assets/js/49bd3d39.********.js 12.8 kB 0 B
demo/build/assets/js/4b891ed6.********.js 8.48 kB 0 B
demo/build/assets/js/4b901b1a.********.js 350 B 0 B
demo/build/assets/js/4c5e977b.********.js 72 kB 0 B
demo/build/assets/js/55960ee5.********.js 383 B 0 B
demo/build/assets/js/55a6d13f.********.js 11.2 kB 0 B
demo/build/assets/js/56717cba.********.js 3.1 kB 0 B
demo/build/assets/js/57f1a671.********.js 8.53 kB 0 B
demo/build/assets/js/5882.********.js 96.4 kB 0 B
demo/build/assets/js/58ff8b1e.********.js 22.2 kB 0 B
demo/build/assets/js/597ddc40.********.js 7.39 kB 0 B
demo/build/assets/js/5f33cfb8.********.js 10.2 kB 0 B
demo/build/assets/js/5fb917be.********.js 2.7 kB 0 B
demo/build/assets/js/63fc267d.********.js 8.04 kB 0 B
demo/build/assets/js/66c76a57.********.js 24.9 kB 0 B
demo/build/assets/js/674cd211.********.js 7.66 kB 0 B
demo/build/assets/js/68b61ac5.********.js 29.5 kB 0 B
demo/build/assets/js/69a61f78.********.js 17.6 kB 0 B
demo/build/assets/js/6a105426.********.js 354 B 0 B
demo/build/assets/js/6d85557e.********.js 7.12 kB 0 B
demo/build/assets/js/73b594ee.********.js 24.9 kB 0 B
demo/build/assets/js/77264a1a.********.js 24.2 kB 0 B
demo/build/assets/js/785615ec.********.js 14.4 kB 0 B
demo/build/assets/js/7b96997a.********.js 2.45 kB 0 B
demo/build/assets/js/7ca3ae45.********.js 13.3 kB 0 B
demo/build/assets/js/7ed7dafe.********.js 18.5 kB 0 B
demo/build/assets/js/7ee7d9e7.********.js 1.55 kB 0 B
demo/build/assets/js/7f6346b9.********.js 8.87 kB 0 B
demo/build/assets/js/83208226.********.js 1.27 kB 0 B
demo/build/assets/js/8596.********.js 3.48 MB 0 B
demo/build/assets/js/85d3c400.********.js 3.02 kB 0 B
demo/build/assets/js/85ec4403.********.js 4.31 kB 0 B
demo/build/assets/js/86b273b1.********.js 7.87 kB 0 B
demo/build/assets/js/86c346b0.********.js 538 B 0 B
demo/build/assets/js/86c45737.********.js 18.7 kB 0 B
demo/build/assets/js/881db345.********.js 395 B 0 B
demo/build/assets/js/8961c7a6.********.js 18.4 kB 0 B
demo/build/assets/js/8973.********.js 104 B 0 B
demo/build/assets/js/8ab9b16e.********.js 7.37 kB 0 B
demo/build/assets/js/8d4e78cd.********.js 2.96 kB 0 B
demo/build/assets/js/8f36b2a3.********.js 173 B 0 B
demo/build/assets/js/8f441c78.********.js 16.8 kB 0 B
demo/build/assets/js/9074.********.js 104 B 0 B
demo/build/assets/js/91696e06.********.js 24.9 kB 0 B
demo/build/assets/js/93304a97.********.js 8.96 kB 0 B
demo/build/assets/js/935f2afb.********.js 40.3 kB 0 B
demo/build/assets/js/94589c06.********.js 15.1 kB 0 B
demo/build/assets/js/967247e2.********.js 12.2 kB 0 B
demo/build/assets/js/97810f3c.********.js 17.7 kB 0 B
demo/build/assets/js/9b5caaf3.********.js 18.2 kB 0 B
demo/build/assets/js/9c42c0f3.********.js 24 kB 0 B
demo/build/assets/js/a40c6d71.********.js 5.71 kB 0 B
demo/build/assets/js/a476e24e.********.js 343 B 0 B
demo/build/assets/js/a6cd895f.********.js 22.7 kB 0 B
demo/build/assets/js/a728d93a.********.js 7.42 kB 0 B
demo/build/assets/js/aa2f1ec7.********.js 17.8 kB 0 B
demo/build/assets/js/ab09fd5c.********.js 22.7 kB 0 B
demo/build/assets/js/ab6072f2.********.js 17.6 kB 0 B
demo/build/assets/js/ae7f40a3.********.js 29.5 kB 0 B
demo/build/assets/js/aedd5031.********.js 7.59 kB 0 B
demo/build/assets/js/b4ebd305.********.js 13.2 kB 0 B
demo/build/assets/js/b5c059ef.********.js 24 kB 0 B
demo/build/assets/js/b89b49f4.********.js 9.67 kB 0 B
demo/build/assets/js/baebb6c1.********.js 2.67 kB 0 B
demo/build/assets/js/bdbe39c2.********.js 2.66 kB 0 B
demo/build/assets/js/bead4b8e.********.js 3.15 kB 0 B
demo/build/assets/js/c5644638.********.js 338 B 0 B
demo/build/assets/js/c65697f5.********.js 17.9 kB 0 B
demo/build/assets/js/c7a5be9f.********.js 7.54 kB 0 B
demo/build/assets/js/c7ded1cb.********.js 3.07 kB 0 B
demo/build/assets/js/cef3f2e2.********.js 5.72 kB 0 B
demo/build/assets/js/cf07762b.********.js 18.8 kB 0 B
demo/build/assets/js/d63c7029.********.js 3.05 kB 0 B
demo/build/assets/js/dc1ed7fc.********.js 7.6 kB 0 B
demo/build/assets/js/dd696920.********.js 17.6 kB 0 B
demo/build/assets/js/df203c0f.********.js 2.9 kB 0 B
demo/build/assets/js/e015ccf9.********.js 18.2 kB 0 B
demo/build/assets/js/e01f8d18.********.js 6.22 kB 0 B
demo/build/assets/js/e2ce9793.********.js 362 B 0 B
demo/build/assets/js/e5e5340c.********.js 2.54 kB 0 B
demo/build/assets/js/e7e42acb.********.js 2.59 kB 0 B
demo/build/assets/js/e8b309fb.********.js 577 B 0 B
demo/build/assets/js/eae14b71.********.js 23.2 kB 0 B
demo/build/assets/js/eaf4471e.********.js 9.38 kB 0 B
demo/build/assets/js/ecc39b49.********.js 172 B 0 B
demo/build/assets/js/ee308fa3.********.js 7.09 kB 0 B
demo/build/assets/js/f212caf7.********.js 18.4 kB 0 B
demo/build/assets/js/f4486b6b.********.js 8.94 kB 0 B
demo/build/assets/js/f4538a24.********.js 2.53 kB 0 B
demo/build/assets/js/f65290a6.********.js 7.83 kB 0 B
demo/build/assets/js/f8409a7e.********.js 41.9 kB 0 B
demo/build/assets/js/f84e10c2.********.js 14.3 kB +8 B (0%)
demo/build/assets/js/fcd67c8d.********.js 13.8 kB 0 B
demo/build/assets/js/fe97f0d1.********.js 15.1 kB +8 B (0%)
demo/build/assets/js/main.********.js 500 kB 0 B
demo/build/assets/js/runtime~main.********.js 9.8 kB 0 B
demo/build/index.html 96.4 kB 0 B

compressed-size-action

Copy link

github-actions bot commented Mar 20, 2024

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

https://docusaurus-openapi-36b86--pr754-7ghqd73i.web.app

(expires Fri, 19 Apr 2024 14:30:03 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

@sserrata sserrata merged commit 69068f7 into main Mar 20, 2024
13 checks passed
@sserrata sserrata deleted the bug/fix-guard-deprecated branch March 20, 2024 14:32
sserrata added a commit that referenced this pull request Mar 20, 2024
…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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working v2.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant