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

feat(docs-util): predefined OAS schemas #7139

Merged
merged 2 commits into from
Apr 25, 2024
Merged

Conversation

shahednasser
Copy link
Member

This PR adds support for predefined OAS schema types that bypass the logic of creating the schema. The need for this resulted from the BigNumber type which, when generated from its type, leads to a combination of types that aren't relevant in OAS. So, BigNumber now always defaults to type string.

Other fixes include:

  • Ensure nested schemas are converted to references.
  • When updating a schema, refer to the correct reference.
  • Fix redocly config to include new circular references (note: would be good to work on a way to automate this to avoid errors, will look into this some other time)

Copy link

changeset-bot bot commented Apr 24, 2024

⚠️ No Changeset found

Latest commit: 0a445dd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Apr 24, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
medusa-dashboard ✅ Ready (Inspect) Visit Preview Apr 24, 2024 7:34am
3 Ignored Deployments
Name Status Preview Updated (UTC)
api-reference ⬜️ Ignored (Inspect) Apr 24, 2024 7:34am
docs-ui ⬜️ Ignored (Inspect) Apr 24, 2024 7:34am
medusa-docs ⬜️ Ignored (Inspect) Apr 24, 2024 7:34am

@olivermrbl olivermrbl merged commit 347aece into develop Apr 25, 2024
24 checks passed
@olivermrbl olivermrbl deleted the docs-util/exclude-schema branch April 25, 2024 08:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants