Extension Field Registry

x-oai-name - An identifier for a Server Object, used when targeting OpenAPI versions prior to 3.2.

OpenAPI 3.2 introduced the name field on Server Objects to provide a unique identifier for a server.

The x-oai-name extension brings this same capability to OpenAPI versions prior to 3.2, allowing you to provide a unique identifier for a Server Object.

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

Used by: (informational)

Schema 

{"type"=>"string"}

Example 

openapi: 3.1.0
info:
  title: My API
  version: 1.0.0
servers:
  - url: https://api.example.com
    x-oai-name: production
    description: Production server
  - url: https://staging.example.com
    x-oai-name: staging
    description: Staging server