Skip to content

Commit 5247abc

Browse files
authored
Merge pull request OAI#1422 from MikeRalphson/v3.0.1
[v3.0.1] Prefer https links where available
2 parents d8d586c + d0f89ec commit 5247abc

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

versions/3.0.1.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [BCP 14](https://tools.ietf.org/html/bcp14) [RFC2119](https://tools.ietf.org/html/rfc2119) [RFC8174](https://tools.ietf.org/html/rfc8174) when, and only when, they appear in all capitals, as shown here.
66

7-
This document is licensed under [The Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).
7+
This document is licensed under [The Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html).
88

99
## Introduction
1010

@@ -75,7 +75,7 @@ Path templating refers to the usage of curly braces ({}) to mark a section of a
7575

7676
##### <a name="mediaTypes"></a>Media Types
7777
Media type definitions are spread across several resources.
78-
The media type definitions SHOULD be in compliance with [RFC6838](http://tools.ietf.org/html/rfc6838).
78+
The media type definitions SHOULD be in compliance with [RFC6838](https://tools.ietf.org/html/rfc6838).
7979

8080
Some examples of possible media type definitions:
8181
```
@@ -92,13 +92,13 @@ Some examples of possible media type definitions:
9292
```
9393
##### <a name="httpCodes"></a>HTTP Status Codes
9494
The HTTP Status Codes are used to indicate the status of the executed operation.
95-
The available status codes are defined by [RFC7231](http://tools.ietf.org/html/rfc7231#section-6) and registered status codes are listed in the [IANA Status Code Registry](http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml).
95+
The available status codes are defined by [RFC7231](https://tools.ietf.org/html/rfc7231#section-6) and registered status codes are listed in the [IANA Status Code Registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml).
9696

9797
## Specification
9898

9999
### Versions
100100

101-
The OpenAPI Specification is versioned using [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html) (semver) and follows the semver specification.
101+
The OpenAPI Specification is versioned using [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) (semver) and follows the semver specification.
102102

103103
The `major`.`minor` portion of the semver (for example `3.0`) SHALL designate the OAS feature set. Typically, *`.patch`* versions address errors in this document, not the feature set. Tooling which supports OAS 3.0 SHOULD be compatible with all OAS 3.0.\* versions. The patch version SHOULD NOT be considered by tooling, making no distinction between `3.0.0` and `3.0.1` for example.
104104

@@ -161,8 +161,8 @@ string | `string` | | |
161161
byte | `string` | `byte` | base64 encoded characters
162162
binary | `string` | `binary` | any sequence of octets
163163
boolean | `boolean` | | |
164-
date | `string` | `date` | As defined by `full-date` - [RFC3339](http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14)
165-
dateTime | `string` | `date-time` | As defined by `date-time` - [RFC3339](http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14)
164+
date | `string` | `date` | As defined by `full-date` - [RFC3339](https://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14)
165+
dateTime | `string` | `date-time` | As defined by `date-time` - [RFC3339](https://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14)
166166
password | `string` | `password` | A hint to UIs to obscure input.
167167

168168
### <a name="richText"></a>Rich Text Formatting
@@ -188,7 +188,7 @@ This is the root document object of the [OpenAPI document](#oasDocument).
188188

189189
Field Name | Type | Description
190190
---|:---:|---
191-
<a name="oasVersion"></a>openapi | `string` | **REQUIRED**. This string MUST be the [semantic version number](http://semver.org/spec/v2.0.0.html) of the [OpenAPI Specification version](#versions) that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is *not* related to the API [`info.version`](#infoVersion) string.
191+
<a name="oasVersion"></a>openapi | `string` | **REQUIRED**. This string MUST be the [semantic version number](https://semver.org/spec/v2.0.0.html) of the [OpenAPI Specification version](#versions) that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is *not* related to the API [`info.version`](#infoVersion) string.
192192
<a name="oasInfo"></a>info | [Info Object](#infoObject) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required.
193193
<a name="oasServers"></a>servers | [[Server Object](#serverObject)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` property is not provided, or is an empty array, the default value would be a [Server Object](#serverObject) with a [url](#serverUrl) value of `/`.
194194
<a name="oasPaths"></a>paths | [Paths Object](#pathsObject) | **REQUIRED**. The available paths and operations for the API.
@@ -232,7 +232,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
232232
},
233233
"license": {
234234
"name": "Apache 2.0",
235-
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
235+
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
236236
},
237237
"version": "1.0.1"
238238
}
@@ -248,7 +248,7 @@ contact:
248248
249249
license:
250250
name: Apache 2.0
251-
url: http://www.apache.org/licenses/LICENSE-2.0.html
251+
url: https://www.apache.org/licenses/LICENSE-2.0.html
252252
version: 1.0.1
253253
```
254254
@@ -300,13 +300,13 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
300300
```json
301301
{
302302
"name": "Apache 2.0",
303-
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
303+
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
304304
}
305305
```
306306

307307
```yaml
308308
name: Apache 2.0
309-
url: http://www.apache.org/licenses/LICENSE-2.0.html
309+
url: https://www.apache.org/licenses/LICENSE-2.0.html
310310
```
311311

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

0 commit comments

Comments
 (0)