Extensions Registry
Master Issue
Contributing
Please raise a Pull-Request and follow the instructions in CONTRIBUTING.md, or open an Issue to contribute or discuss a registry value.
Values
| Value | Description | Issue |
|---|---|---|
| x-agent-trust | Trust-level metadata block for agent-authenticated security schemes. Required by apiKey security schemes that use Agent-Signature as the header. Carries algorithm, trust level vocabulary, and JWKS endpoint for local verification. | |
| x-codeSamples | Provides custom code samples for an operation in one or more programming languages. | |
| x-jsonschema-$anchor | The JSON Schema $anchor identifier for a schema resource, used when targeting OpenAPI versions that do not directly support it. | |
| x-jsonschema-contains | The JSON Schema contains subschema for array elements, used when targeting OpenAPI versions that do not directly support it. | |
| x-jsonschema-contentEncoding | The JSON Schema contentEncoding annotation, used when targeting OpenAPI versions that do not directly support it. | |
| x-jsonschema-contentMediaType | The JSON Schema contentMediaType annotation, used when targeting OpenAPI versions that do not directly support it. | |
| x-jsonschema-contentSchema | The JSON Schema contentSchema subschema for decoded string content, used when targeting OpenAPI versions that do not directly support it. | |
| x-jsonschema-dependentSchemas | A map of schemas that apply when corresponding properties are present, used when targeting OpenAPI versions that do not directly support dependentSchemas. | |
| x-jsonschema-else | The JSON Schema else conditional subschema, used with x-jsonschema-if when targeting OpenAPI versions that do not directly support it. | |
| x-jsonschema-maxContains | The maximum number of array elements that may match contains, used when targeting OpenAPI versions that do not directly support maxContains. | |
| x-jsonschema-minContains | The minimum number of array elements that must match contains, used when targeting OpenAPI versions that do not directly support minContains. | |
| x-jsonschema-patternProperties | A map of regular expressions to schemas for matching property names, used when targeting OpenAPI versions that do not directly support patternProperties. | |
| x-jsonschema-propertyNames | A schema applied to property names in an object, used when targeting OpenAPI versions that do not directly support propertyNames. | |
| x-jsonschema-then | The JSON Schema then conditional subschema, used with x-jsonschema-if when targeting OpenAPI versions that do not directly support it. | |
| x-jsonschema-unevaluatedProperties | The JSON Schema unevaluatedProperties keyword, used when targeting OpenAPI versions that do not directly support it. | |
| x-oai-additionalOperations | Represents non-standard HTTP method operations on a Path Item when targeting OpenAPI versions prior to 3.2. | |
| x-oai-dataValue | A structured example value for an Example Object, used when targeting OpenAPI versions prior to 3.2. | |
| x-oai-deprecated | Indicates that a Security Scheme is deprecated, used when targeting OpenAPI versions prior to 3.2. | |
| x-oai-deviceAuthorizationUrl | The device authorization URL for an OAuth2 flow (RFC 8628), used when targeting OpenAPI versions prior to 3.2. | |
| x-oai-encoding | A map of nested encoding definitions for an Encoding Object, used when targeting OpenAPI versions prior to 3.2. | |
| x-oai-itemEncoding | Encoding properties for individual items in a multipart request part, used when targeting OpenAPI versions prior to 3.2. | |
| x-oai-itemSchema | Schema for individual items in a multipart request part, used when targeting OpenAPI versions prior to 3.2. | |
| x-oai-name | An identifier for a Server Object, used when targeting OpenAPI versions prior to 3.2. | |
| x-oai-prefixEncoding | Encoding properties applied before the item encoding in a multipart request part, used when targeting OpenAPI versions prior to 3.2. | |
| x-oai-serializedValue | A serialized example value for an Example Object, used when targeting OpenAPI versions prior to 3.2. | |
| x-oai-summary | A short summary for a Response Object, used when targeting OpenAPI versions prior to 3.2. | |
| x-twitter | Used to hold a reference to the API provider’s Twitter account. |