possibly null property not allowed by ibm-schema-type-format on OpenAPI 3.1

[kornysietsma]

I'm trying to define a possibly null property, as far as I can tell in OpenAPI 3.1 the syntax should be:

  myData:
    type: object
    properties:
        fooBar:
          anyOf:
            - $ref: '#/components/schemas/foos'
            - type: 'null'

This clashes with ibm-schema-type-format which returns an error:

Message : Invalid type; valid types are: array, boolean, integer, number, object, string

[padamstx]

@kornysietsma are you trying to define a property that could take on a JSON null value (i.e. it's "nullable") or are you trying to define a property without a type (which would mean that it could be of any JSON-defined type (string, object, integer, float, etc.)?

After investigating a bit more, I'm going to assume that you are trying to define a nullable property. It looks like we'll need to adjust the rule implementation so that it allows one to specify "null" as the type.

[kornysietsma]

yep, trying to allow a null value like

"myData":  {
    "fooBar": null
}

[m4rcingsxr]

Hello, also ibm-avoid-inline-schemas rule require null to be defined as $ref.
I don't know if this is a correct behaviour or not

[pyrooka]

@kornysietsma @m4rcingsxr We've just discussed this internally, but it will take some time to make progress. We'll post updates here.