Extension Field Registry

x-jsonschema-contentEncoding - The JSON Schema contentEncoding annotation, used when targeting OpenAPI versions that do not directly support it.

JSON Schema defines the contentEncoding annotation to describe how a string value is encoded.

The x-jsonschema-contentEncoding extension mirrors this JSON Schema keyword when targeting OpenAPI versions where the keyword is not directly available, serializing it as x-jsonschema-contentEncoding.

It can appear as a property in the following objects: ["Schema Object"].

Used by: (informational)

• Microsoft.OpenApi (.NET OpenAPI library)

Schema

{"type"=>"string"}

Example

openapi: 3.0.4
info:
  title: My API
  version: 1.0.0
paths: {}
components:
  schemas:
    ImageData:
      type: string
      x-jsonschema-contentEncoding: base64