I too like leveraging the examples inside OpenAPI documents. I wish 2 more capabilities in the spec.
1. Ability to correlate a specific request with response using something unique beyond the name of the example. Its really useful to document error samples. e.g. https://docs.stripe.com/error-codes#amount-too-large
I too like leveraging the examples inside OpenAPI documents. I wish 2 more capabilities in the spec.
1. Ability to correlate a specific request with response using something unique beyond the name of the example. Its really useful to document error samples. e.g. https://docs.stripe.com/error-codes#amount-too-large
2. also, examples could support headers to capture the complete interaction/story. e.g. POST /print/jobs returns 202 Accepted with Location header. e.g. 2 https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/async-operations#create-storage-account-202-with-location-and-retry-after