-
Notifications
You must be signed in to change notification settings - Fork 14.6k
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Fix incorrect default on readonly property in our API #32510
Fix incorrect default on readonly property in our API #32510
Conversation
The new version of openapi-spec-validator (0.6.0) started to detect a bug in our API specification - readonly values cannot have defaults (by definition). This PR fixes the problem and also bumps the openapi-spec-validator to >= 0.6.0 to make sure it is used everywhere.
6643c8d
to
bcacf52
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don’t know what the issue this finds, but if the validator says so, so it is.
It makes no sense to have default on readOnly property. |
default -> what value should be set automatically when we call an API when we miss to set it. This property is only returned by the API, so it should always be present and needs to be set (so there will never be case that we will have to assume some defaults). |
https://swagger.io/docs/specification/data-models/data-types/#readonly-writeonly TIL:
|
Static checks passed, API tests passed. merging. |
The new version of openapi-spec-validator (0.6.0) started to detect a bug in our API specification - readonly values cannot have defaults (by definition).
This PR fixes the problem and also bumps the openapi-spec-validator to >= 0.6.0 to make sure it is used everywhere.
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rst
or{issue_number}.significant.rst
, in newsfragments.