instrumenta / openapi2jsonschema

Convert OpenAPI definitions into JSON schemas for all types in the API
Other
226 stars 87 forks source link

Schema conversion conflates "optional field" with "allowing null values" #44

Open jcmcken opened 3 years ago

jcmcken commented 3 years ago

Similar issue was reported here but this might be a better home for it, not sure.

In this code the tool conflates an optional field (i.e. a field that does not have to be specified) with a field that allows null values. But this is not correct and these are distinct things in some cases (e.g. Kubernetes schemas)

As a real world example, if you have a Kubernetes Deployment and set a secret volume like this (with secretName having the null value)...

...
spec:
  volumes:
    - name: somevol
      secret:
        secretName:
...

The schema produced from openapi2jsonschema using kubeval will happily consider this config valid. But if you try to apply the config using kubectl or kustomize, it complains that secretName cannot take a null value. And indeed if you look at the upstream schema, nowhere does it specify that the field is nullable.