Extension Field Registry
x-oai-license-identifier - An SPDX license expression for a License Object, used when targeting OpenAPI versions prior to 3.1.
OpenAPI 3.1 introduced the identifier field on License Objects to identify a license using an SPDX license expression.
The x-oai-license-identifier extension brings this same capability to OpenAPI versions prior to 3.1, allowing you to identify a license using an SPDX license expression on a License Object.
Use this extension only with OpenAPI versions before 3.1; OpenAPI 3.1 and later define identifier directly. When using this extension, follow the same semantics as identifier: use an SPDX license expression and do not use it together with url for the same License Object.
It can appear as a property in the following objects: ["License Object"].
Used by: (informational)
- Microsoft.OpenApi (.NET OpenAPI library)
- TypeSpec (API description language and tooling)
Schema
{"type"=>"string"}
Example
openapi: 3.0.3
info:
title: My API
version: 1.0.0
license:
name: Apache 2.0
x-oai-license-identifier: Apache-2.0
paths: {}