-
Notifications
You must be signed in to change notification settings - Fork 9.1k
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
[4.0 Scope] Make readOnly and writeOnly fully aligned with JSON Schema #2169
Comments
wait, does that mean that @OAI/tsc has decided to make these incompatible with JSON Schema in OAS 3.1? |
@handrews, OpenAPI 3.0 specifies that a So yes, OAS 3.x is incompatible in this one case because it assumes context-sensitive validation, which JSON Schema doesn't support. In this comment, I described three possible workarounds, assuming we don't magically solve this JSON Schema compatibility issue in 3.1. In this comment, @MikeRalphson says we should publish those workarounds somewhere, and (presumably) accept that we can't fix it in 3.1. If other TSC members want to weigh in, or if anyone has a better idea of how to handle this, please chime in. |
@tedepstein that is not how I interpreted @MikeRalphson's comment (I probably read the last several comments in that issue too quickly). I will follow up over there. |
Believe this can be closed, as resolved for 3.1 |
This is a placeholder for a follow-up task to consider in the next major release cycle.
In #1622, we discussed the new definition of
readOnly
andwriteOnly
annotations in JSON Schema. OpenAPI 3.1 cannot simply defer to this definition, because it has different semantics that would amount to a breaking change. But we should consider making this change in 4.0.The text was updated successfully, but these errors were encountered: