How to add example of body to metadata?

[BashkaMen]

i want add example body to openApi and use it on scalar

[pimbrouwers]

I apologize for the delay. I am a bit confused, could you elaborate?

Is it possible to add this as part of your string literal description?

get "/" (Response.ofPlainText "Hello World!")
    |> OpenApi.name "HelloWorld"
    |> OpenApi.summary "This is a summary"
    |> OpenApi.description "This is a test description, which is the long form of the summary"
                                           // ^-- add your example here
    |> OpenApi.returnType typeof<string>

[katatunix]

I apologize for the delay. I am a bit confused, could you elaborate?

Is it possible to add this as part of your string literal description?

get "/" (Response.ofPlainText "Hello World!")
|> OpenApi.name "HelloWorld"
|> OpenApi.summary "This is a summary"
|> OpenApi.description "This is a test description, which is the long form of the summary"
// ^-- add your example here
|> OpenApi.returnType typeof

The OP was asking for this feature of OpenAPI: https://swagger.io/docs/specification/v3_0/adding-examples/

[pimbrouwers]

Thanks for the clarification @katatunix. I'll get to working on this addition to parameters.