Extension Field Registry

x-oai-serializedValue - A serialized example value for an Example Object, used when targeting OpenAPI versions prior to 3.2.

OpenAPI 3.2 introduced the serializedValue field on Example Objects to provide already-serialized example data.

The x-oai-serializedValue extension brings this same capability to OpenAPI versions prior to 3.2, allowing you to provide already-serialized example data on an Example Object.

Use this extension only with OpenAPI versions before 3.2; OpenAPI 3.2 and later define serializedValue directly.

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

Used by: (informational)

• Microsoft.OpenApi (.NET OpenAPI library)

Schema

{"type"=>"string"}

Example

openapi: 3.1.0
info:
  title: My API
  version: 1.0.0
paths: {}
components:
  examples:
    csvExample:
      summary: A CSV example
      x-oai-serializedValue: "id,name\n1,Ada"