Extension Field Registry

x-oai-summary - A short summary for a Response Object, used when targeting OpenAPI versions prior to 3.2.

OpenAPI 3.2 introduced the summary field on Response Objects to provide a short summary of a response.

The x-oai-summary extension brings this same capability to OpenAPI versions prior to 3.2, allowing you to provide a short summary of a response.

It can appear as a property in the following objects: ["Response 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:
  /widgets:
    get:
      responses:
        "200":
          description: A list of widgets
          x-oai-summary: Widget list