Skip to content

Schema examples dont show #152

@AngryUbuntuNerd

Description

@AngryUbuntuNerd

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions