-
Notifications
You must be signed in to change notification settings - Fork 87
Open
Description
I have the given openapi.json which is generated using fastapi
(I chopped it down to the relevant parts).
The relevant snippet is this one:
{
"components": {
"schemas": {
"Schedule": {
"examples": [
{
"schedule_id": "111111l901",
"task": "ping"
}
]
},
"ScheduleRequest": {
"examples": [
{
"task": "ping"
}
]
}
}
}
}
This is following the OpenAPI standard 3.1.0 which claims:
The
example
property has been deprecated in favor of the JSON Schemaexamples
keyword. Use ofexample
is discouraged, and later versions of this specification may remove it.
Now I have added it to my docs using this block
.. openapi:: ./openapi.json
:examples:
But the generated examples are not using the examples
from the document:
Notice that it says "string"
instead of "111111l901"
and "ping"
as in the examples
. It works better, but still not fully, when using example
instead.
I can not figure out how to fix this in the code, so was wondering if someone can help.
tommyjcarpenter
Metadata
Metadata
Assignees
Labels
No labels