OpenAPI · Schema

OpenAPI Encoding Object

A single encoding definition applied to a single schema property.

DocumentationRESTSpecification

Properties

Name Type Description
contentType string The Content-Type for encoding a specific property.
headers object A map allowing additional information to be provided as headers.
style string Describes how a specific property value will be serialized.
explode boolean Whether parameter values of type array or object generate separate parameters.
allowReserved boolean Whether the parameter value allows reserved characters.
View JSON Schema on GitHub

JSON Schema

openapi-encoding.json Raw ↑ 
{
  "$id": "openapi-encoding.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "OpenAPI Encoding Object",
  "description": "A single encoding definition applied to a single schema property.",
  "type": "object",
  "properties": {
    "contentType": {
      "type": "string",
      "description": "The Content-Type for encoding a specific property."
    },
    "headers": {
      "type": "object",
      "description": "A map allowing additional information to be provided as headers.",
      "additionalProperties": {
        "$ref": "openapi-header.json"
      }
    },
    "style": {
      "type": "string",
      "description": "Describes how a specific property value will be serialized."
    },
    "explode": {
      "type": "boolean",
      "description": "Whether parameter values of type array or object generate separate parameters."
    },
    "allowReserved": {
      "type": "boolean",
      "description": "Whether the parameter value allows reserved characters.",
      "default": false
    }
  },
  "patternProperties": {
    "^x-": {}
  },
  "additionalProperties": false
}