You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When I try to create examples for parameters like shown in the file below, scalar and swagger docs both end up failing to render the docs for the API because it's an invalid format.
While I note there are other types defined for ExampleObject where the type is any this is what my TS server is resolving.
Please update the examples to be correct and also, if possible, change the types returned by TypeBox so that it's clear what the object shape needs to be for OpenAPI to work.
The text was updated successfully, but these errors were encountered:
When I try to create examples for parameters like shown in the file below, scalar and swagger docs both end up failing to render the docs for the API because it's an invalid format.
This line and those like it:
https://github.com/elysiajs/elysia-swagger/blob/4f51a403fbcbb7ca13b929bb9526f4ddade524bc/example/plugin.ts#L61C23-L61C48
Show an invalid way to present an example for a property.
Please see the following types:
ParameterBaseObject
https://github.com/kogosoftwarellc/open-api/blob/1b48b2556221a57c6b739b5a6c1648f49bc465ec/packages/openapi-types/index.ts#L376-L387Which uses
ExampleObject
https://github.com/kogosoftwarellc/open-api/blob/1b48b2556221a57c6b739b5a6c1648f49bc465ec/packages/openapi-types/index.ts#L465-L470
While I note there are other types defined for
ExampleObject
where the type isany
this is what my TS server is resolving.Please update the examples to be correct and also, if possible, change the types returned by TypeBox so that it's clear what the object shape needs to be for OpenAPI to work.
The text was updated successfully, but these errors were encountered: