openapi-spec-validator icon indicating copy to clipboard operation
openapi-spec-validator copied to clipboard

Allow "required" list to have undefined properties

Open sisp opened this issue 5 years ago • 4 comments

I think requiring property names listed in required to be defined in properties is too strict. I also couldn't find this requirement in the JSON Schema or OpenAPI specs. JSON Schema validators and the Swagger Editor are fine with property names listed in required that are not defined in properties.

It makes sense to list required properties without defining them in properties when using allOf where one sub-schema requires some properties but does not specify them while another sub-schema only provides the specifications of the properties (possibly even without stating which ones are required and which ones aren't). This is especially useful when referencing and merging schema definitions or when expressing discriminated unions with some properties that are common to all union members.

I suggest to remove the following code block

https://github.com/p1c2u/openapi-spec-validator/blob/3f53e957812a9c545d71226e3a4d696240e2cee6/openapi_spec_validator/validators.py#L134-L142

and the require_properties argument:

https://github.com/p1c2u/openapi-spec-validator/blob/3f53e957812a9c545d71226e3a4d696240e2cee6/openapi_spec_validator/validators.py#L123

I have seen the test case

https://github.com/p1c2u/openapi-spec-validator/blob/3f53e957812a9c545d71226e3a4d696240e2cee6/tests/integration/test_validators.py#L83-L115

but it also seems to be valid to express this schema like this:

{
    'Credit': {
        'type': 'object',
        'properties': {
            'clientId': {'type': 'string'},
        }
    },
    'CreditCreate': {
        'type': 'object',
        'required': ['clientId'],
        'allOf': [
            {
                '$ref': '#/components/schemas/Credit'
            },
            # possibly more schemas to merge ...
        ]
    }
}

Or did I miss this rule somewhere in the spec?

sisp avatar Aug 03 '20 16:08 sisp

Hi Guys, did any one figure out a workaround for this problem changing the spec?

edermaxc avatar Jul 21 '21 12:07 edermaxc

@p1c2u I did a pull request to solve this issue (https://github.com/p1c2u/openapi-spec-validator/pull/154) . Could you review it please ? We are currently blocked on our side, it will helpful to have a status on it.

hibougeek avatar Jun 16 '22 14:06 hibougeek

Thanks @hibougeek ! We are blocked by this also.

Marwen94 avatar Jun 16 '22 14:06 Marwen94