Skip to content

Commit c69c832

Browse files
committed
Add SPDX identifier field to license object, fixes OAI#1599
1 parent e3c236a commit c69c832

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

versions/3.1.0.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,8 @@ License information for the exposed API.
295295
Field Name | Type | Description
296296
---|:---:|---
297297
<a name="licenseName"></a>name | `string` | **REQUIRED**. The license name used for the API.
298-
<a name="licenseUrl"></a>url | `string` | A URL to the license used for the API. MUST be in the format of a URL.
298+
<a name="licenseIdentifier"></a>identifier | `string` | An [SPDX](https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60) license expression for the API. The `identifier` field is mutually exclusive of the `url` field.
299+
<a name="licenseUrl"></a>url | `string` | A URL to the license used for the API. MUST be in the format of a URL. The `url` field is mutually exclusive of the `identifier` field.
299300

300301
This object MAY be extended with [Specification Extensions](#specificationExtensions).
301302

@@ -304,13 +305,13 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
304305
```json
305306
{
306307
"name": "Apache 2.0",
307-
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
308+
"identifier": "Apache-2.0"
308309
}
309310
```
310311

311312
```yaml
312313
name: Apache 2.0
313-
url: https://www.apache.org/licenses/LICENSE-2.0.html
314+
identifier: Apache-2.0
314315
```
315316

316317
#### <a name="serverObject"></a>Server Object

0 commit comments

Comments
 (0)