Index of examples to create

[darrelmiller]

Suggestions for scenarios that we could create examples for.

• Info examples
  • Valid Version numbers
  • Example License identifiers
• Servers Examples
  • Sandbox vs Prod
• Paths Examples
• Parameter Examples
  • Non escaped path parameter
  • JSON Object query parameter
  • Date query parameter
  • Boolean query parameter
• Content examples
  • Heterogenous collection of JSON objects
  • Empty collection
  • Paged Collection
• Response Examples
  • Long running operation (202)
  • Created example (201)
  • [ ]
• Security Examples
  • Using scopes
  • API Key
  • Client Credential OAuth2
  • Auth Code OAuth2
• Tags Examples
  • Global Tags
  • Inline Tags

[darcyrush]

Asides from adding an example of examples for multipart/form-data requestBody (#2734) I would also like to suggest adding an example of examples for parameters using pattern to describe URL parameter nested objects (#1706) like url.com?filter[query][eq]=value.

Since deeply nested objects are not agreed on or supported by OAS, but are widely used, even a "simple" regex example would convey that this is not officially supported, whilst still providing a starting point that users can use to implement some basic validation when using tooling.

[lornajane]

Where were these examples going to be used? I wonder if these might be something for learn.openapis.org

[lornajane]

@darrelmiller Could you please put this one on the Learn repo? I think we're more likely to be able to action it there.