Payload examples for OAS

[BernieWhite]

Just wanting to know if there is an easy way to generate payload examples for OAS 3 specs.

I was hoping there was an easy @example option I could use to specify an example model for request/ response payload schemas.

Any suggestions of where to start?

[NielsCo]

I also didn't find any easy way to do this. Maybe write an Issue for this?

I have a suggestion for a very wonky workaround.
You could use an extension of OAS and then remove the "x" in a script.

Your example would be defined like this:

@extension("x-example", {id: "test", weight: 23123, color: "blue"})
model Widget {
  @key id: string;
  weight: int32;
  color: "red" | "blue";
}

Here is a playground-link
And then you would need to write a script that removes the "x-"
Obviously this isn't type-checked or anything as you can define anything you'd like to be an extension.

Type-Checked examples would be a very cool feature for TypeSpec IMHO.
If you're too busy to write the issue, let me know and I'll write it. Didn't want to take credit for it.

[BernieWhite]

Logged as #2087