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

{type: number, format: int32} should be a validation error #96

Closed
jayvdb opened this issue Dec 12, 2022 · 5 comments
Closed

{type: number, format: int32} should be a validation error #96

jayvdb opened this issue Dec 12, 2022 · 5 comments
Labels
New passive check New passive check

Comments

@jayvdb
Copy link
Contributor

jayvdb commented Dec 12, 2022

Is your feature request related to a problem? Please describe.
{type: number, format: int32} is not ideal OAS 3.0.3, as it defines a format which should be an integer, but uses type: number when the type: integer should be used.

As it is ambiguous, the validator should emit an error of some sort, as openapi tools are very likely to either ignore either type or format, or fail when trying to combined the two.

An example of a tool which silently ignores the format is oxidecomputer/progenitor#266

Describe the solution you'd like
Detect type: number and a integer format, and type: integer and a float format.

https://github.com/zalando/zally (Kotlin) does detect this as rule MUST define a format for number and integer types

Describe alternatives you've considered

Additional context

@OmerWow
Copy link
Contributor

OmerWow commented Dec 12, 2022

Hey @jayvdb

Thanks for the feature suggestion!

We're thinking about adding a new passive check that will check for integrity of types, is that what you had in mind?

@jayvdb
Copy link
Contributor Author

jayvdb commented Dec 12, 2022

Yes

@OmerWow
Copy link
Contributor

OmerWow commented Dec 13, 2022

Great then!

We're adding this to our future development plans, thanks for the suggestion :)

@OmerWow
Copy link
Contributor

OmerWow commented Dec 13, 2022

Hey @jayvdb

Just wanted to let you know we're adding the new passive check to Cherrybomb, this is the link to the PR: #97

Thanks again for the suggestion :)

@DeliciousBounty
Copy link
Collaborator

Hii @jayvdb
Just wanted to let you know that there is a new passive check that responds to your feature suggestion:

pub fn check_int_type(&self) -> Vec<Alert> {

I close this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
New passive check New passive check
Projects
None yet
Development

No branches or pull requests

3 participants