Skip to content

Commit fc7a7c1

Browse files
chore(docs): update docs and references for OAS to 3.0.4 (#390)
* chore(docs): update examples and references to OAS 3.0.4
1 parent 6c11076 commit fc7a7c1

24 files changed

+38
-40
lines changed

src/components/Homepage.astro

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ const basePath = import.meta.env.BASE_URL;
4343
buttonTitle="View Docs"
4444
optionalText="View on GitHub"
4545
path={`${basePath}specification/v3_0/about/`}
46-
optionalPath="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md"
46+
optionalPath="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.4.md"
4747
cards={2}
4848
><svg
4949
height="16"

src/content/docs/specification/v3_0/Authentication/api-keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ API keys are supposed to be a secret that only the client and server know. Like
3535
In OpenAPI 3.0, API keys are described as follows:
3636
3737
```yaml
38-
openapi: 3.0.0
38+
openapi: 3.0.4
3939
---
4040
# 1) Define the key name and location
4141
components:

src/content/docs/specification/v3_0/Authentication/basic-authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Authorization: Basic ZGVtbzpwQDU1dzByZA==
2121
Using OpenAPI 3.0, you can describe Basic authentication as follows:
2222
2323
```yaml
24-
openapi: 3.0.0
24+
openapi: 3.0.4
2525
---
2626
components:
2727
securitySchemes:

src/content/docs/specification/v3_0/Authentication/bearer-authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The Bearer authentication scheme was originally created as part of [OAuth 2.0](/
2121
In OpenAPI 3.0, Bearer authentication is a security scheme with `type: http` and `scheme: bearer`. You first need to define the security scheme under `components/securitySchemes`, then use the `security` keyword to apply this scheme to the desired scope – global (as in the example below) or specific operations:
2222

2323
```yaml
24-
openapi: 3.0.0
24+
openapi: 3.0.4
2525
---
2626
# 1) Define the security scheme type (HTTP bearer)
2727
components:

src/content/docs/specification/v3_0/Authentication/cookie-authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Cookie: JSESSIONID=abcde12345
3434
In OpenAPI 3.0 terms, cookie authentication is an [API key](/docs/specification/authentication/api-keys/) that is sent `in: cookie`. For example, authentication via a cookie named `JSESSIONID` is defined as follows:
3535

3636
```yaml
37-
openapi: 3.0.0
37+
openapi: 3.0.4
3838
---
3939
# 1) Define the cookie name
4040
components:

src/content/docs/specification/v3_0/Authentication/openid-connect-discovery.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ This URL returns a JSON listing of the OpenID/OAuth endpoints, supported scopes
3333
OpenAPI 3.0 lets you describe OpenID Connect Discovery as follows:
3434

3535
```yaml
36-
openapi: 3.0.0
36+
openapi: 3.0.4
3737
---
3838
# 1) Define the security scheme type and attributes
3939
components:

src/content/docs/specification/v3_0/Data Models/data-models.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar:
88
OAS **3** This guide is for OpenAPI 3.0.
99
:::
1010

11-
OpenAPI 3.0 data types are based on an extended subset [JSON Schema Specification Wright Draft 00](https://tools.ietf.org/html/draft-wright-json-schema-00#section-4.2) (aka Draft 5). The data types are described using a [Schema object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#schemaObject). To learn how to model various data types, see the following topics:
11+
OpenAPI 3.0 data types are based on an extended subset [JSON Schema Specification Wright Draft 00](https://tools.ietf.org/html/draft-wright-json-schema-00#section-4.2) (aka Draft 5). The data types are described using a [Schema object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.4.md#schema-object). To learn how to model various data types, see the following topics:
1212

1313
- [Data Types](/docs/specification/data-models/data-types/)
1414
- [Enums](/docs/specification/data-models/enums/)

src/content/docs/specification/v3_0/Data Models/keywords.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ OpenAPI schemas can also use the following keywords that are not part of JSON Sc
7272

7373
### References
7474

75-
[OpenAPI 3.0 – Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#schema-object)
75+
[OpenAPI 3.0 – Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.4.md#schema-object)
7676

7777
[JSON Schema Validation](https://tools.ietf.org/html/draft-wright-json-schema-validation-00) – JSON Schema keyword reference
7878

src/content/docs/specification/v3_0/Data Models/oneof-anyof-allof-not.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,6 @@ The following request bodies are **not valid**:
156156
"age": 3 # Does not include the pet_type property
157157
}
158158

159-
160-
161159
{
162160
"pet_type": "Cat",
163161
"bark": true # The `Cat` schema does not have the `bark` property

src/content/docs/specification/v3_0/Data Models/representing-xml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ Note that the `xml.name` property of the wrapping element (`books` in our exampl
274274

275275
### Reference
276276

277-
[XML Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#xmlObject)
277+
[XML Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.4.md#xml-object)
278278

279279
_Did not find what you were looking for? [Ask the community](https://community.smartbear.com/t5/Swagger-Open-Source-Tools/bd-p/SwaggerOSTools)
280280
Found a mistake? [Let us know](https://github.com/swagger-api/swagger.io/issues)_

0 commit comments

Comments
 (0)