kogosoftwarellc / open-api

A Monorepo of various packages to power OpenAPI in node
MIT License
892 stars 235 forks source link

openapi-request-validator: Fix componentSchemas type (fixes #820) #821

Open aldex32 opened 2 years ago

jsdevel commented 2 years ago

thanks @aldex32 . i believe this is technically a breaking change correct?

aldex32 commented 2 years ago

Hey @jsdevel , yes it is a breaking change. I can avoid it buy making it backward compatible like this:

  componentSchemas?: IJsonSchema[] | { [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject; };

But I am not sure if the type IJsonSchema[] is/was correct. Also all the tests I see in this project are not assigning any array to this field. Unfortunately the tests are not type checking the arguments passed to the constructor of OpenAPIRequestValidator and this probably was the reason of not catching the wrong type.

jsdevel commented 2 years ago

@aldex32 breaking change doesn't scare me. is this in line with th OpenAPI schema?

jsdevel commented 2 years ago

@aldex32 ?