x-6a-template
A template value defines the default content provided in an API user interface. Generally this can be considered a “reasonable” or “typical” value for API requests, but is not the same as a static or default value in the OpenAPI document. Note especially this difference because a schema default would be supplied by a server implementation in the absence of a submitted value.
Template values are most use within an API Client when combined with variables, as they can save repetitive typing of a common value across many endpoints (such as a user ID used by multiple GET endpoints). Variables in a template are surrounded by double-curly-brackets e.g. {{varname}}
Field Name | Type | Description |
---|---|---|
x-6a-template | string | A string used to automatically fill in UI values |
Found in
Template values are most often found in endpoint parameters and headers. (TODO: fill in all supported locations)