Validation error: `examples` must be an array about openapi3-ts HOT 7 CLOSED

@pjmolina , it seems that the changes made by #124 are wrong, because the property examples exists in multiple interfaces. In most cases it's really the ExampleObject, but within the SchemaObject examples still has to be an array.
I'm suggesting to revert #124 .

from openapi3-ts.

@RobinTail I see my mistake now. Thanks for pointing that out. Sorry for the bug 😄

from openapi3-ts.

Thansk for the analysis @RobinTail

from openapi3-ts.

I based those changes off the OpenAPI Specification 3.0 and 3.1

from openapi3-ts.

The examples you refer to, are NOT the property of SchemaObject.
This is the examples property of ComponentsObject, @kkolstad

Anyway, thank you very much for responding.

from openapi3-ts.

Hey @kkolstad when I read the Open API spec 3.1, i see that ParameterObject has a examples field that can be set to Map[ string, Example Object | Reference Object]

How do i use this type to add examples to my Open Api spec ?

Best

from openapi3-ts.

Regarding the particular examples in ParameterObject you refer to, @vafanassieff:

What they call Map is a Record in Typescript.
So you assign examples with object having keys as string and values as ExampleObject | ReferenceObject

...
examples: {
  example1: {
    value: "something"
  }
}

See the definition of ExampleObject here:
https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#example-object

It's typed correctly in the library and not related to this issue.

from openapi3-ts.