-
Notifications
You must be signed in to change notification settings - Fork 8
Open
Labels
enhancementNew feature or requestNew feature or request
Description
Changing the nullability of an object or property might lead to backward incompatible specs.
For easier understanding we can use the following example
definitions:
model:
type: object
x-model: Model
properties:
prop:
type: stringwith the above example we should consider {"prop": "a"} or {} as valid Model and {"prop": null} as invalid.
But adding x-model: true into prop property it makes {"prop": null} a valid Model.
This change is:
- backward compatible if the object is used in requests parameters, as old clients would continue to send
Modelinstances - backward incompatible if the object is used in responses, as old clients might start receiving
nullvalues which were not supposed to receive
The objective of this issue is to track the implementation of two complementary rules
- add
x-nullableinto response models - removing
x-nullablefrom request models
Internal reference: CORESERV-9265
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request