Skip to content

Commit 70ecce7

Browse files
authored
Add SPDX identifier field to license object, fixes #1599 (#2105)
1 parent c376bef commit 70ecce7

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
@@ -297,7 +297,8 @@ License information for the exposed API.
297297
Field Name | Type | Description
298298
---|:---:|---
299299
<a name="licenseName"></a>name | `string` | **REQUIRED**. The license name used for the API.
300-
<a name="licenseUrl"></a>url | `string` | A URL to the license used for the API. MUST be in the format of a URL.
300+
<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.
301+
<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.
301302

302303
This object MAY be extended with [Specification Extensions](#specificationExtensions).
303304

@@ -306,13 +307,13 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
306307
```json
307308
{
308309
"name": "Apache 2.0",
309-
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
310+
"identifier": "Apache-2.0"
310311
}
311312
```
312313

313314
```yaml
314315
name: Apache 2.0
315-
url: https://www.apache.org/licenses/LICENSE-2.0.html
316+
identifier: Apache-2.0
316317
```
317318

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

0 commit comments

Comments
 (0)