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

[FR] Additional supported fields for index.api.mdx #96

Merged
merged 8 commits into from
May 20, 2022
Merged

Conversation

blindaa121
Copy link
Collaborator

@blindaa121 blindaa121 commented May 20, 2022

Description

See #89

This PR consists of the following changes:

  • Additional info fields from OAS files can now be written to index.api.mdx(Introduction doc).
    • info.contact
    • info.termsOfService
    • info.license
  • Removed unused instances of create*Tables.ts

Motivation and Context

How Has This Been Tested?

  • Generated Petstore Introduction doc and ensured the supported fields were being written to index.api.mdx and rendered accordingly.
  • Ensured there were no errors when generating OpenAPI docs for other specs

Screenshots (if appropriate)

Screen Shot 2022-05-19 at 5 25 32 PM

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes if appropriate.
  • All new and existing tests passed.

@blindaa121 blindaa121 added enhancement New feature or request DO NOT MERGE labels May 20, 2022
@blindaa121 blindaa121 self-assigned this May 20, 2022
@github-actions
Copy link

github-actions bot commented May 20, 2022

Size Change: +837 B (0%)

Total Size: 2.38 MB

Filename Size Change
demo/build/assets/js/b549f425.********.js 5.54 kB +837 B (+18%) ⚠️
ℹ️ View Unchanged
Filename Size
demo/.docusaurus/globalData.json 9.3 kB
demo/build/assets/css/styles.********.css 85.6 kB
demo/build/assets/js/03d773ca.********.js 572 B
demo/build/assets/js/05098950.********.js 9.85 kB
demo/build/assets/js/0e384e19.********.js 2.39 kB
demo/build/assets/js/135394ac.********.js 11.6 kB
demo/build/assets/js/13f7b013.********.js 15.3 kB
demo/build/assets/js/14eb3368.********.js 8.66 kB
demo/build/assets/js/17896441.********.js 11.2 kB
demo/build/assets/js/18c41134.********.js 14.7 kB
demo/build/assets/js/1a71454d.********.js 190 B
demo/build/assets/js/1a9c2752.********.js 16.6 kB
demo/build/assets/js/1be78505.********.js 10.8 kB
demo/build/assets/js/1e4232ab.********.js 3.45 kB
demo/build/assets/js/1f391b9e.********.js 958 B
demo/build/assets/js/1f41b3da.********.js 11.6 kB
demo/build/assets/js/267885ec.********.js 20.1 kB
demo/build/assets/js/271404ad.********.js 15.8 kB
demo/build/assets/js/2b85808b.********.js 427 B
demo/build/assets/js/393be207.********.js 920 B
demo/build/assets/js/3a924100.********.js 17.9 kB
demo/build/assets/js/3d193392.********.js 2.53 kB
demo/build/assets/js/3f30461f.********.js 11 kB
demo/build/assets/js/3f7c113d.********.js 29.5 kB
demo/build/assets/js/4151a9a3.********.js 20.7 kB
demo/build/assets/js/4c5e977b.********.js 31.3 kB
demo/build/assets/js/533a09ca.********.js 2.79 kB
demo/build/assets/js/5547b4e6.********.js 17.6 kB
demo/build/assets/js/556fa72d.********.js 1.54 kB
demo/build/assets/js/5c868d36.********.js 3.52 kB
demo/build/assets/js/6119.********.js 1.09 kB
demo/build/assets/js/6a1cccb8.********.js 1.47 kB
demo/build/assets/js/6e5387e3.********.js 8.71 kB
demo/build/assets/js/70090257.********.js 20.4 kB
demo/build/assets/js/7608cde2.********.js 1.16 kB
demo/build/assets/js/7df67612.********.js 16.5 kB
demo/build/assets/js/7fb2c1f3.********.js 2.44 kB
demo/build/assets/js/8038.********.js 1.09 MB
demo/build/assets/js/822bd8ab.********.js 3.19 kB
demo/build/assets/js/8411.********.js 12.8 kB
demo/build/assets/js/888b62d9.********.js 1.3 kB
demo/build/assets/js/8906f45a.********.js 9.95 kB
demo/build/assets/js/8a18f3bf.********.js 17.1 kB
demo/build/assets/js/8c7cea15.********.js 19.6 kB
demo/build/assets/js/935f2afb.********.js 3.54 kB
demo/build/assets/js/960b46e9.********.js 22.3 kB
demo/build/assets/js/9719473f.********.js 1.16 kB
demo/build/assets/js/99178e05.********.js 11 kB
demo/build/assets/js/a8b9f4aa.********.js 10.3 kB
demo/build/assets/js/bfdd0584.********.js 9.61 kB
demo/build/assets/js/c4f5d8e4.********.js 72.3 kB
demo/build/assets/js/c771eeef.********.js 11.8 kB
demo/build/assets/js/c97f956e.********.js 2.15 kB
demo/build/assets/js/cc12b702.********.js 405 B
demo/build/assets/js/cf404dba.********.js 442 B
demo/build/assets/js/common.********.js 125 kB
demo/build/assets/js/d5bd4b02.********.js 4.41 kB
demo/build/assets/js/dff1c289.********.js 4.18 kB
demo/build/assets/js/e44a2883.********.js 5.43 kB
demo/build/assets/js/e5cbb61f.********.js 191 B
demo/build/assets/js/e7f14080.********.js 6.91 kB
demo/build/assets/js/ecc39b49.********.js 190 B
demo/build/assets/js/f55d3e7a.********.js 3.01 kB
demo/build/assets/js/main.********.js 403 kB
demo/build/assets/js/runtime~main.********.js 6.62 kB
demo/build/index.html 72.8 kB

compressed-size-action

@github-actions
Copy link

github-actions bot commented May 20, 2022

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

https://docusaurus-openapi-36b86--pr96-dgtyy8jn.web.app

(expires Sun, 19 Jun 2022 19:01:31 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

@blindaa121 blindaa121 requested a review from sserrata May 20, 2022 17:12
@blindaa121
Copy link
Collaborator Author

@sserrata Latest commits reflect reverting back to the original markdown folder structure. Thanks for the insight! 👍 Ready for review now

Copy link
Member

@sserrata sserrata left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me 👍🏽

@blindaa121 blindaa121 merged commit 63934e4 into main May 20, 2022
@blindaa121 blindaa121 deleted the update-info-doc branch May 20, 2022 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DO NOT MERGE enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants