Skip to content

Commit 885b6be

Browse files
author
Ron
authored
Merge branch 'OpenAPI.next' into 2016-11-grammar-diction
2 parents eed483f + 6389e18 commit 885b6be

File tree

5 files changed

+1359
-917
lines changed

5 files changed

+1359
-917
lines changed

DEVELOPMENT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The specification _will change_ from the original 2.0 version. We should typica
2727
- Use labels for the workflow of specification changes. For example, this may be labeled as `proposed`, `needs migration review`, `needs tooling review`, `needs documentation`, `rejected`, `needs approval`. These labels must be assigned by project committers
2828
- An issue will be opened for each feature change. Embedded in the issue OR ideally linked in a file via pull-request (PR), a document should be supplied for use cases for the change
2929
- A PR will be used to describe the _proposed_ solution, and linked to the original issue
30-
- Not all committers will contribute to ever single proposed change. There may be many open proposals at once, and multiple efforts may happen in parallel
30+
- Not all committers will contribute to every single proposed change. There may be many open proposals at once, and multiple efforts may happen in parallel
3131
- When the OpenApi.next spec is complete and approved for release, the branch will be merged to master.
3232

3333
## Approving Changes

IMPLEMENTATIONS.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
### Implementations
2+
3+
Below is a list of known tooling implementing the 3.0.0 specification. Because
4+
the 3.0.0 specification has not yet been released, please consult the details of
5+
any projects listed below for notes about stability and roadmap. The process
6+
to create the best possible 3.0.0 specification includes feedback from end-users
7+
and tooling creators alike, and it is strongly encouraged that draft tooling be
8+
made available for early users of the OAS.
9+
10+
These tools are not necessarily endorsed by the OAI.
11+
12+
#### Low-Level tooling
13+
14+
| Title | Project Link | Language |Description |
15+
|----------------|--------------|----------|---------------------|
16+
| swagger-parser | [GitHub/swagger-api](https://github.com/swagger-api/swagger-parser/tree/feature/3.0.0-rc0) | Java | Swagger 1.0, 1.1, 1.2, 2.0 to Open API Specification converter |
17+
| swagger-models | [GitHub/swagger-api](https://github.com/swagger-api/swagger-core/tree/feature/3.0.0-rc0/modules/swagger-models) | Java | Open API 3.0 Java Pojos |
18+
| KaiZen OpenAPI Parser | [GitHub/RepreZen/KaiZen-OpenAPI-Parser](https://github.com/RepreZen/KaiZen-OpenAPI-Parser) | Java | High-performance Parser, Validator, and Java Object Model for OpenAPI 3.x |
19+
| openapi3-ts | [GitHub/metadevpro/openapi3-ts](https://github.com/metadevpro/openapi3-ts) | TypeScript | TS Model & utils for OpenAPI 3.0.x contracts |
20+
| swagger2openapi | [GitHub/mermade/swagger2openapi](https://github.com/mermade/swagger2openapi) | Node.js | An OpenAPI / Swagger 2.0 to OpenAPI 3.0.x converter and validator |
21+
| Tavis.OpenApi | [GitHub/tavis-sofware/Tavis.OpenApi](https://github.com/tavis-software/Tavis.OpenApi/) | dotnet | C# based parser with definition validation and migration support from V2 |
22+
23+
24+
#### User Interfaces
25+
26+
| Title | Project Link | Language |Description |
27+
|----------------|--------------|----------|---------------------|
28+
| openapi-viewer | [GitHub/koumoul/openapi-viewer](https://github.com/koumoul-dev/openapi-viewer) | Vue.js | Browse and test a REST API described with the OpenAPI 3.0 Specification |
29+
30+
31+
#### Server Implementations
32+
33+
34+
#### Code Generators
35+
36+
| Title | Project Link | Language |Description |
37+
|----------------|--------------|----------|---------------------|
38+
| baucis-openapi3 | [Github/metadevpro/baucis-openapi3](https://github.com/metadevpro/baucis-openapi3) | Node.js | [Baucis.js](https://github.com/wprl/baucis) plugin for generating OpenAPI 3.0 compliant API contracts |
39+
| Google Gnostic | [GitHub/googleapis/gnostic](https://github.com/googleapis/gnostic) | Go | Compile OpenAPI descriptions into equivalent Protocol Buffer representations |

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# The OpenAPI Specification
22

3+
### Draft implementations of tooling supporting the 3.0.0 specification can be found here!
4+
5+
[3.0.0 Implementations](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/IMPLEMENTATIONS.md)
6+
37
This is the working branch for the next version of the OpenAPI Specification. You can read more about the Open API Initiative (OAI) at [https://openapis.org](https://openapis.org).
48

59
The current, released version of the OpenAPI Specification is 2.0, through donation of the Swagger Specification to the OAI by SmartBear Software. If you are interested in the release specification, please see the [master branch](https://github.com/OAI/OpenAPI-Specification/blob/master/README.md) of this project.

fixtures/v2.0/json/resources/resourceWithLinkedDefinitions_part1.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@
2424
"200": {
2525
"description": "pet response",
2626
"schema": {
27-
"$ref": "#/definitions/Pet"
27+
"$ref": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/fixtures/v2.0/json/resources/resourceWithLinkedDefinitions.json#/definitions/Pet"
2828
}
2929
},
3030
"default": {
3131
"description": "error payload",
3232
"schema": {
33-
"$ref": "#/definitions/ErrorModel"
33+
"$ref": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/fixtures/v2.0/json/resources/resourceWithLinkedDefinitions.json#/definitions/ErrorModel"
3434
}
3535
}
3636
}

0 commit comments

Comments
 (0)