Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Schema examples dont show #152

Open
AngryUbuntuNerd opened this issue Mar 22, 2024 · 2 comments
Open

Schema examples dont show #152

AngryUbuntuNerd opened this issue Mar 22, 2024 · 2 comments

Comments

@AngryUbuntuNerd
Copy link

AngryUbuntuNerd commented Mar 22, 2024

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 Schema examples keyword. Use of example 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:

Screenshot from 2024-03-22 17-40-01
Screenshot from 2024-03-22 17-39-55

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.

@stephenfin
Copy link
Member

Yeah we don't support examples at the moment. Those would need to be added.

@AngryUbuntuNerd
Copy link
Author

Happy to put together a PR for adding the support. Would just need a few pointers where to make the changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants