Skip to content

Commit c401ae6

Browse files
committed
Update guidelines for v3 and Swagger --> OAS
1 parent 4875e02 commit c401ae6

File tree

4 files changed

+18
-18
lines changed

4 files changed

+18
-18
lines changed

guidelines/README.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

guidelines/EXTENSIONS.md renamed to guidelines/v2.0/EXTENSIONS.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
# Swagger Extensions
1+
# OpenAPI Extensions
22

3-
The Swagger 2.0 specification allows for custom properties to be added at several places within a Swagger definition, allowing
3+
The OpenAPI Specification version 2.0 allows for custom properties to be added at several places within an OpenAPI definition, allowing
44
API providers to extend the meta-data provided for their REST APIs as needed. Extension properties are always
55
prefixed by "x-" and can have any valid JSON format value.
66

77
Currently extension properties are supported in the following definition objects:
88

9-
* within the [info object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#info-object)
10-
* within the [paths object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#paths-object)
11-
* within the [path-item object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#path-item-object)
12-
* within the [operation object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#operationObject)
13-
* within the [parameter object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#parameterObject)
14-
* within the [responses object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#responses-object)
15-
* within the [tag object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#tag-object)
16-
* within the [security-scheme object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#security-scheme-object)
9+
* within the [info object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/2.0.md#info-object)
10+
* within the [paths object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/2.0.md#paths-object)
11+
* within the [path-item object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/2.0.md#path-item-object)
12+
* within the [operation object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/2.0.md#operationObject)
13+
* within the [parameter object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/2.0.md#parameterObject)
14+
* within the [responses object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/2.0.md#responses-object)
15+
* within the [tag object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/2.0.md#tag-object)
16+
* within the [security-scheme object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/2.0.md#security-scheme-object)
1717

18-
For example, a vendor extension that adds apis.json specific metadata a Swagger definition might look as follows:
18+
For example, a vendor extension that adds apis.json specific metadata to an OpenAPI definition might look as follows:
1919

2020
```json
2121
{
@@ -59,8 +59,8 @@ For example, a vendor extension that adds apis.json specific metadata a Swagger
5959
}
6060
```
6161

62-
This could be used by corresponding tooling that builds apis.json files for swagger definitions, the advantage being that all metadata
63-
for a Swagger API is within one definition instead of spread out amongst multiple files.
62+
This could be used by corresponding tooling that builds apis.json files for OpenAPI definitions, the advantage being that all metadata
63+
for the API is within one definition instead of spread out amongst multiple files.
6464

6565
Another (simplified) example could be how to specify a [JWE encryption](http://hdknr.github.io/docs/identity/jwe.html) policy to parameters,
6666
for example as follows:
@@ -89,4 +89,4 @@ An API consumer reading these parameter definitions could interpret this as havi
8989

9090
## Annotations
9191

92-
The Swagger-specific annotations currently available for jax-rs APIs do not support the addition of extension data.
92+
The OpenAPI-specific annotations currently available for jax-rs APIs do not support the addition of extension data.

guidelines/v2.0/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## Guidelines for OpenAPI Definitions
2+
3+
* [Reuse](REUSE.md) of OpenAPI definitions
4+
* [Extending](EXTENSIONS.md) OpenAPI definitions with custom metadata
File renamed without changes.

0 commit comments

Comments
 (0)