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

Fix validation errors for Swagger Open API #11228

Merged
merged 7 commits into from Aug 18, 2021

Conversation

MatthewKennedy
Copy link
Contributor

@MatthewKennedy MatthewKennedy commented Aug 11, 2021

  • Fix errors for $ref '#...' nested under an object unnecessarily.
  • Set compliant operation ID's
  • Add global Tags.
  • Use string example where type is declared string.
  • Set cart example to match the Schema.
  • use anyOf: where appropriate.
  • convert IdOrPermalink into 2 separate references, one dedicated productSlug and another for taxonPermalink so examples are more relevant to each.

@viezly
Copy link

viezly bot commented Aug 11, 2021

Changes preview:

👀 Review pull request on Viezly

@@ -5078,7 +5109,7 @@ components:
included:
type: array
items:
oneOf:
anyOf:
Copy link
Member

Choose a reason for hiding this comment

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

@MatthewKennedy this change breaks displaying of States in includes

Screenshot 2021-08-17 at 17 15 11

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll look into it...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can't see the states in the live docs either:

Live Docs:
Screenshot 2021-08-17 at 18 34 08

New Version
Screenshot 2021-08-17 at 18 37 25

@damianlegawiec damianlegawiec merged commit 4bf6dfd into master Aug 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants