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

edit spectral rules #1039

Merged
merged 5 commits into from
Dec 15, 2023
Merged

edit spectral rules #1039

merged 5 commits into from
Dec 15, 2023

Conversation

julia-rabello
Copy link
Contributor

@julia-rabello julia-rabello commented Nov 3, 2023

  • avoid triggering rule when items property is inside an example (fix items-description and items-type)

  • avoid triggering error rules when the same schema is used for both a request and a response (turn request-body-objects-arrays-example and response-body-objects-arrays-example into warn instead of error)

Types of changes

  • New content (endpoints, descriptions or fields from scratch)
  • Improvement (make an endpoint's title or description even better)
  • Spelling and grammar accuracy (self-explanatory)

Changelog

Do not forget to update your changes to our Developer Portal's changelog. Did you create a release note?

  • Yes, I already created a release note about this change.
  • No, but I am going to.

avoid triggering rule when items property is inside an example
@julia-rabello julia-rabello self-assigned this Nov 3, 2023
Copy link

github-actions bot commented Nov 3, 2023

Thanks for your contribution. The .json file will be checked now with Spectral.

@julia-rabello julia-rabello changed the title fix items-description and items-type edit spectral rules Nov 3, 2023
@julia-rabello julia-rabello marked this pull request as ready for review November 3, 2023 13:19
Copy link
Contributor

@PedroAntunesCosta PedroAntunesCosta left a comment

Choose a reason for hiding this comment

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

LGTM

@julia-rabello julia-rabello merged commit a9e5d23 into master Dec 15, 2023
3 checks passed
@julia-rabello julia-rabello deleted the update-spectral branch December 15, 2023 13:14
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.

2 participants