| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
Sorry, something went wrong.
Address OAI#715 - State (explicitly) whether Open API schema object definitions are open or closed for extension.
|
Looks good to me. I'd probably say "or an empty schema" or "or the empty schema" rather than "or empty schema" but I'm not picky if this is consistent with usage elsewhere. |
Sorry, something went wrong.
Address OAI#715 - State (explicitly) whether Open API schema object definitions are open or closed for extension. Add 'an' for readability.
|
Thanks, @handrews . I made that change. |
Sorry, something went wrong.
Updated suggested text to simplify
| Back | FazBrowse Home | New Git URL |
Address #715 - State (explicitly) whether Open API schema object definitions are open or closed for extension.
This was the topic of many discussions around OpenAPI 2.0 and earlier Swagger specifications. Here are some of them:
OpenAPI 2.0 assumed additionalProperties: false as the default, and disallowed explicit use of a boolean additionalProperties value. This was never fully documented, only stated in out-of-band comments. And those comments were never really reconciled with allOf semantics, which magically continued to work as though additionalProperties: true were the default.
I wasn't aware, and I'm guessing that some others also weren't aware, that this changed intentionally in the 3.0 spec. The current 3.0.1 spec explicitly states that boolean values are allowed, but doesn't explicitly state that the default is now additionalProperties: true.
I think it's worth making this explicit now, because anyone who got caught up in the 2.0 additionalProperties confusion is likely to need some assurance that this change is intentional, and not subject to informal amendments or clarifications made outside of the spec.
@handrews and I were both looking for that assurance, and couldn't find it. So I'm suggesting this small change.