Discussions

Ask a Question
Back to All

How do I get example responses to display?

(edited)

I have examples included in the OpenApi.json but the example does not display in the readme.com. The example do display in both swaggerUI and redoc.

The example is included in the component.schema object and looks like the following...

{
    "components": {
        "schemas": {
            "Video": {
                "required": [
                    "title"
                ],
                "type": "object",
                "properties": {
                    "title": {
                        "maxLength": 255,
                        "type": "string"
                    },
                    "summary": {
                        "maxLength": 2000,
                        "type": "string",
                        "nullable": true
                    }
                },
                "example": "video example object"
            }
        }
    }
}

Start typing markdown or type / to insert a block