Feature Request: Example parameter values

[gmr]

I know this is somewhat bleeding into the open-api spec itself, so I understand if this is too much scope creep, but I'd love to be able to provide example values for parameter values. The examples are great for responses, but for requests, the auto-built examples built off of type are good, but utilitarian.

So for example, I could set a x-example attribute for a parameter in a schema I could turn this:

to

Does that seem reasonable? I tried to go down the x-code-snippets route but it wasn't quite the same as what I was trying to achieve.

[RomanHotsiy]

@gmr, this is actually supported by both OpenAPI spec and ReDoc :)

You can use example field on Schema Object.

So you can specify example on property level (see example in our demo spec or even on schema level):

{
  "type": "object",
  "properties": {
    // ...
  },
  "example": {
     "user": "gmr",
     "notes": " this is a example note",
     "bin": "9656534-32429432-34329432-bbc3234"
  }
}

Does it solve your problem?

[gmr]

Ah my bad, I missed the example attribute, or conflated it with examples for responses.

[cbautista1002]

Thanks guys!

But for anyone who stumbles across this post and is hoping to add the example to each individual property - you can do that with example:

{
  "type": "object",
  "properties": {
    "user": {
      "type": "string",
      "description": "the user name",
      "example": "gmr"
    }
  }
}

I prefer this approach because it keeps the example right next to the definition and it avoids duplicating the field names.