x-examples for request body param does not display

[MarcLevisse]

If I use the x-examples vendor extension with ReDoc 2.0.0-rc56 (idem 48) the custom example does not display and generated one from schema is displayed in place

simple_swagger2_test_with_x-examples.txt

any idea if I'm doing something wrong or if there is a bug somewhere ?

thx a lot

[MarcLevisse]

{
    "swagger": "2.0",
    "info": {
        "description": "test",
        "version": "v4",
        "title": "test",
        "license": {
            "name": "test"
        }
    },
    "basePath": "/v4",
    "x-stoplight": {
        "docs": {
            "showModels": false
        }
    },
    "paths": {
        "/test": {
            "post": {
                "operationId": "test",
                "summary": "test",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "in": "body",
                        "name": "test",
                        "description": "test",
                        "schema": {
                            "type": "object",
                            "properties": {
                                "key": {
                                    "type": "string"
                                }
                            }
                        },
                        "x-examples": {
                            "application/json": {
                                "key": "customerId"
                            }
                        }
                    }
                ]
            }
        }
    }
}

[RomanHotsiy]

This is expected behaviour. We do not show request body examples in the middle panel. They are shown in the right panel.

[MarcLevisse]

that's indeed my issue, it does not show in the right panel ...

the example displayed is

{
   "key": "string"
}

(generated)
but should have been

{
   "key": "customerId"
}

(custom one from x-examples)

[RomanHotsiy]

Ah, I apologize, looks like x-examples support was missed during react rewrite 😳 .

We'll fix that.

[MarcLevisse]

you're welcome ! ;)

[adamaltman]

https://redoc.ly/docs/api-reference-docs/specification-extensions/x-examples/

It seems the usage is slightly incorrect too. It should be like:

                        "x-examples": {
                                "application/json": {
                                   "your-example-name": {
                                      "value": {
                                          "key": "customerId"
                                       }
                                   }
                               }
                         }

[MarcLevisse]

indeed

anyway tried with this:

{
    "swagger": "2.0",
    "info": {
        "title": "test",
        "version": "v4",
        "description": "test",
        "license": {
            "name": "test"
        }
    },
    "basePath": "/v4",
    "paths": {
        "/test": {
            "post": {
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "test",
                        "description": "test",
                        "schema": {
                            "type": "object",
                            "properties": {
                                "key": {
                                    "type": "string"
                                }
                            }
                        },
                        "in": "body",
                        "x-examples": {
                            "application/json": {
                                "a-sample": {
                                    "summary": "Some Example",
                                    "value": {
                                        "key": "customerId"
                                    }
                                },
                                "another-sample": {
                                    "summary": "Some Other Example",
                                    "value": {
                                        "key": "anotherKey"
                                    }
                                }
                            }
                        }
                    }
                ],
                "responses": {
                    "201": {
                        "description": "Created"
                    }
                },
                "operationId": "test",
                "summary": "test"
            }
        }
    }
}

and result is the same :

none of my two samples are displayed and no dropdown to choose between two samples

[MarcLevisse]

Hi guys ! Is there a chance that this regression bug is being addressed soon ?
(I would be glad not to have to migrate dozens of swagger 2.0 spec files to 3.0)

thx !

[MarcLevisse]

thx for the fix
anyway, can you provide me with a working x-examples Swagger 2.0 sample ?
I've upgraded to 2.0.0-rc59 and I can't face why it still does not work

thx

[RomanHotsiy]

@MarcLevisse check out this https://redoc.ly/docs/api-reference-docs/specification-extensions/x-examples/

[MarcLevisse]

ok your sample matches mine
but in fact through openapi-cli "preview" command it works
I guess I have an issue with my upgrade to 2.0.0-rc59 in my ReDoc standalone integration

[MarcLevisse]

perfect, re run yarn install on my docusaurus project and it cleaned unused but still present redoc 2.0.0-rc57
that works ! thx a lot for your kind support !