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

Zally not validating APIs for Open API 3.1.0. #1230

Open
tkrop opened this issue May 5, 2021 · 8 comments
Open

Zally not validating APIs for Open API 3.1.0. #1230

tkrop opened this issue May 5, 2021 · 8 comments
Labels
area: rules status: blocked The issue is blocked by other issue in external dependency type: bug

Comments

@tkrop
Copy link
Member

tkrop commented May 5, 2021

It seems as if there is a switch preventing the rules to get into action on Open API version 3.1.0, that has been released on Feb 15th, 2021. Checking APIs with openapi: 3.0.3 that show violations show now violations after updating to openapi: 3.1.0 without other changes.

@vadeg
Copy link
Contributor

vadeg commented May 29, 2021

@tkrop do you have API example?

@tkrop
Copy link
Member Author

tkrop commented Jun 8, 2021

@vadeg you can take any 3.0.x API you know off and mark it as 3.1.0.

@vadeg
Copy link
Contributor

vadeg commented Jun 9, 2021

Swagger parser doesn't support 3.1.0 yet. See swagger-api/swagger-parser#1535.

Basically, the parser ignores any schemas which do not start from 3.0. See this line:

if (value == null || !value.startsWith("3.0")) {			
    return null;			
}

@tkrop
Copy link
Member Author

tkrop commented Jun 9, 2021

Updating swagger parser to latest version is also not simple. The maximum we can currently achieve without fixing logic is 2.0.18 as I have tested out. Beyond this version we are stumbling about behavioral changes in of the parser that break rules. I have not verified the logic so far, but I expect that we also may need to updated the swagger/openapi3-schema.json files and add the file for the 3.1 schema.

Remark: Updating the swagger model to the latest version seems to be no problem.

@vadeg
Copy link
Contributor

vadeg commented Jun 9, 2021

I have checked the latest swagger parser version. It has the same problem. Swagger parser will be updated together with kotlin and Java in #1254

@vadeg
Copy link
Contributor

vadeg commented Jun 9, 2021

Blocked by #1255 and swagger-api/swagger-parser#1535.

@vadeg vadeg added status: blocked The issue is blocked by other issue in external dependency and removed type: bug help wanted labels Jun 23, 2021
@LasneF
Copy link

LasneF commented Dec 13, 2023

any news there ? @vadeg , @tkrop the issue you mentionned swagger-api/swagger-parser#1535
looks fixed as statement below
also here
https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---OpenAPI-3.1

so we should be good here isn't it ?

@vadeg
Copy link
Contributor

vadeg commented Jan 14, 2024

@LasneF thank you for the update. I will have a look.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: rules status: blocked The issue is blocked by other issue in external dependency type: bug
Projects
None yet
Development

No branches or pull requests

3 participants