Skip to content

Commit

Permalink
Add SPDX identifier field to license object, fixes #1599 (#2105)
Browse files Browse the repository at this point in the history
  • Loading branch information
MikeRalphson authored Feb 27, 2020
1 parent c376bef commit 70ecce7
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions versions/3.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,8 @@ License information for the exposed API.
Field Name | Type | Description
---|:---:|---
<a name="licenseName"></a>name | `string` | **REQUIRED**. The license name used for the API.
<a name="licenseUrl"></a>url | `string` | A URL to the license used for the API. MUST be in the format of a URL.
<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.
<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.

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

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

```yaml
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
identifier: Apache-2.0
```

#### <a name="serverObject"></a>Server Object
Expand Down

0 comments on commit 70ecce7

Please sign in to comment.