Use null instead of 'null' in null objects schema #40
Conversation
There was a problem hiding this comment.
Thanks for the changes. LGTM
null is a valid type allowed by JSON Schema (because it is a JSON Object) and the OAS (3.0.X - note we are not compliant with versions 3.1.X) imposes that the type used in type must conform to the defined type for the Schema Object.
FTR: OAS 3.1.X does support the
nulltype doing something like:type: ["null", "string"], sonullableis deprecated. We should state somewhere that the yielded OAS is 3.0.X-compliant, so that client can adapt their tooling.
Once we add nullable: true we are adding "null" to the list of strings allowed in the property type. So, given that the only allowed value for a type: "null" is, actually, the literal null, the changes in this PR seem to be OK.
However, note that this fine-grained semantic validation is not implemented in most of the editors, as the vast majority only leverage the lexical/syntactic level. For instance, the examples in this PR (pre PR and post PR) will both be "correct" in, for example, Swagger Editor,
Signed-off-by: Miguel A. Cabrera Minagorri <[email protected]>
miguelaeh
force-pushed
the
fixNullString
branch
from
fe14397
to
77eb4a2
Compare
Signed-off-by: Miguel A. Cabrera Minagorri [email protected]
Description of the change
Null objects were being set as
"null"(note string) instead ofnullinto the schema. This PR fixes that and sets it properly.Benefits
Possible drawbacks
Applicable issues
Additional information
Checklist
package.jsonandpackage-lock.jsonaccording to semver.testsfoldernpm test