Extension Field Registry

x-oai-$self - The canonical absolute URI for an OpenAPI document, used when targeting OpenAPI versions prior to 3.2.

OpenAPI 3.2 introduced the $self field on OpenAPI Objects to identify the canonical absolute URI for an OpenAPI document.

The x-oai-$self extension brings this same capability to OpenAPI versions prior to 3.2, allowing you to identify the canonical absolute URI for an OpenAPI document.

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

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

Used by: (informational)

• Microsoft.OpenApi (.NET OpenAPI library)

Schema

{"type"=>"string", "format"=>"uri"}

Example

openapi: 3.1.0
info:
  title: My API
  version: 1.0.0
x-oai-$self: https://example.org/api/openapi.json
paths: {}