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

oneOf rule should apply to OpenAPI 2.0 only #9

Closed
arthurcogo opened this issue Jan 9, 2023 · 2 comments
Closed

oneOf rule should apply to OpenAPI 2.0 only #9

arthurcogo opened this issue Jan 9, 2023 · 2 comments

Comments

@arthurcogo
Copy link

The ruleset currently has the following rule:

image

However, the AWS documentation states:

oneOf is not supported for OpenAPI 2.0 or SDK generation.

I have been able to use oneOf successfully in API Gateway with 3.0 which seems to confirm this.

Therefore, I suggest that this rule only applies to OpenAPI 2.0 specs.

@andylockran
Copy link
Owner

Thanks for the feedback, unfortunately due to time constraints I'd not worked out how to differentiate between the two AWS OpenAPI implementations, so am assuming that this library should only work with the v3 fork of OpenAPI.

As the AWS documentation has been updated, I will fix this by removing the warning around oneOf not being supported, and make it clearer in the README that this is only targetting openapiV3-aws.

@andylockran
Copy link
Owner

Thank you so much - this has now been released.

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

No branches or pull requests

2 participants