Examples

[timotheeguerin]

Fix #2700 Add support for @example and @opExample

Playground demo

[azure-sdk]

All changed packages have been documented.

• ✅ @typespec/compiler
• ✅ @typespec/openapi3

Show changes

@typespec/openapi3 - feature ✏️

Add support for new @example and @opExample decorator

@typespec/compiler - feature ✏️

Add new @example and @opExample decorator to provide examples on types and operations.,> ,> tsp,> @example(#{,> id: "some",,> date: utcDateTime.fromISO("2020-01-01T00:00:00Z"),,> timeout: duration.fromISO("PT1M"),,> }),> model Foo {,> id: string;,> date: utcDateTime;,> ,> @encode("seconds", int32) timeout: duration;,> },> ,> ,> tsp,> @opExample(,> #{,> parameters: #{,> pet: #{,> id: "some",,> name: "Fluffy",,> dob: plainDate.fromISO("2020-01-01"),,> },,> },,> returnType: #{,> id: "some",,> name: "Fluffy",,> dob: plainDate.fromISO("2020-01-01"),,> },,> },,> #{ title: "First", description: "Show creating a pet" },> ),> op createPet(pet: Pet): Pet;,>

[azure-sdk]

You can try these changes at https://cadlplayground.z22.web.core.windows.net/prs/3572/

Check the website changes at https://tspwebsitepr.z22.web.core.windows.net/prs/3572/

[azure-sdk]

You can try these changes here

🛝 Playground	🌐 Website	📚 Next docs