Extension Field Registry

x-oai-deprecated - Indicates that a Security Scheme is deprecated, used when targeting OpenAPI versions prior to 3.2.

OpenAPI 3.2 introduced the deprecated field on Security Scheme Objects to indicate that a security scheme is deprecated and SHOULD be transitioned out of usage.

The x-oai-deprecated extension brings this same capability to OpenAPI versions prior to 3.2, allowing you to indicate that a Security Scheme Object is deprecated and SHOULD be transitioned out of usage.

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

Used by: (informational)

• Microsoft.OpenApi (.NET OpenAPI library)

Schema

{"type"=>"boolean"}

Example

openapi: 3.1.0
info:
  title: My API
  version: 1.0.0
components:
  securitySchemes:
    legacyApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      x-oai-deprecated: true