Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

3.1.0 Release #2462

Merged
merged 76 commits into from
Feb 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
76 commits
Select commit Hold shift + click to select a range
7a5b183
3.1.0 prep
webron Oct 8, 2018
77f86eb
Update README
webron Oct 8, 2018
e985f13
Allow specification extensions in discriminator object
MikeRalphson Oct 18, 2018
eb92123
Note that specification extensions beginning x-oas- are reserved
MikeRalphson Oct 18, 2018
3083f1a
Merge pull request #1715 from MikeRalphson/specext-oas
webron Oct 18, 2018
334cf53
Merge pull request #1714 from MikeRalphson/discrim-ext
webron Oct 18, 2018
d27bb1c
security; add mutualTLS securityScheme type
MikeRalphson Nov 27, 2018
a76dad5
Merge pull request #1764 from MikeRalphson/v3.1-mutualTLS
webron Feb 7, 2019
5f6a25a
832 add info.summary (#1779)
ioggstream Feb 28, 2019
5044418
fix OIDC url and OAuth2 requirements
AxelNennker Jun 21, 2019
192aafe
Merge pull request #1959 from AxelNennker/fix_OICD_and_OAuth2
MikeRalphson Aug 6, 2019
ac236d1
Update Schema Object to proper JSON Schema
Jun 21, 2019
f8f92ed
update vocab and arbitrary props
Oct 25, 2019
e121405
another go at arbitrary keywords
Oct 28, 2019
5905f45
feedback from @handrews
Oct 29, 2019
0ec2c73
Support style, explode, allowReserved encoding for multipart/form-dat…
Nov 27, 2019
4822592
default should match json schema
Jan 9, 2020
d67f350
removed json schema keyworld list, its just all of em.
Jan 9, 2020
bb9a6f2
redundant $ref reference
Jan 9, 2020
e3c236a
Merge pull request #1977 from philsturgeon/json-schema-update
webron Jan 9, 2020
fd39bcd
Correct Styles Values for spaceDelimited and pipeDelimited, as based …
Arhimenrius Jan 10, 2020
61f9d7e
Add support for webhooks as a top-level element (#2103)
lornajane Jan 16, 2020
3cb92bd
Align the OAS 3.1 nullable language with the 3.0.3 (#2115)
handrews Feb 6, 2020
c37a305
allow, but discourage, requestBody for GET, HEAD, DELETE (#2117)
n2ygk Feb 6, 2020
92a9104
Reference Object and Schema Object use of $ref updates for 2019-09 / …
handrews Feb 6, 2020
c376bef
Fix table cell formatting containing `nullable` description (#2152)
hkosova Feb 21, 2020
70ecce7
Add SPDX identifier field to license object, fixes #1599 (#2105)
MikeRalphson Feb 27, 2020
c6415fe
Add information about objects to the description too
Arhimenrius Mar 11, 2020
a6b99bc
Make paths object optional (#1781)
MikeRalphson Mar 19, 2020
b5a15df
Fwd port v3.0.3 dev to v3.1.0 dev (#2163)
MikeRalphson Mar 19, 2020
b45d0d8
security; widen use of scopes array to other securityScheme types (#1…
MikeRalphson Mar 19, 2020
cafadc9
Allow summary and description as $ref siblings (#2181)
MikeRalphson Mar 26, 2020
6abda3b
Merge pull request #2101 from Arhimenrius/correct-style-values-types
earth2marsh Apr 9, 2020
1a8d44f
HTTP not REST (#1946)
philsturgeon Apr 9, 2020
d5b65bb
Missing updates
webron May 6, 2020
3678d30
Merge pull request #2224 from OAI/Missing-updates
MikeRalphson May 7, 2020
ece5497
Remove boolean compatibility for exclusive* (#2226)
handrews May 14, 2020
69662e4
Update "format" and "content*" for new JSON Schema (#2200)
handrews May 28, 2020
835a18f
[3.1.0-dev] drop OAS semver requirement (#2243)
MikeRalphson May 28, 2020
ee77d2d
Remove "nullable" entirely (#2246)
handrews May 28, 2020
5e48cd6
x-oas- to x-oai- (v3.1.0-dev)
MikeRalphson Jun 4, 2020
3a96dfe
Update version for release (#2269)
webron Jun 18, 2020
df7f5f9
$schema Guidance (#2266)
philsturgeon Jul 23, 2020
f997bca
x-oai- / x-oas-; reserve both
MikeRalphson Aug 27, 2020
912ef8d
v3.1.0: rephrase data-type section because `format` keyword can be us…
sebastien-rosset Aug 27, 2020
437b407
Added change to address #2287 (#2328)
darrelmiller Sep 3, 2020
280ae0e
Make Server Variable Object's properties more strict (#2335)
webron Sep 3, 2020
99ceb0b
docs(Components): fix typo in schemas field type (#2337)
char0n Sep 4, 2020
4ad45ad
Fix indentation of a YAML comment
hkosova Sep 17, 2020
7fc06e0
Removed required constraint on responses object (#2329)
darrelmiller Oct 1, 2020
0e91fe8
Merge pull request #2352 from hkosova/comment-indent-fix
MikeRalphson Oct 7, 2020
8da2c2a
3.1.0-rc1 Release prep (#2369)
webron Oct 8, 2020
9d59a51
Merge branch 'master' into v3.1.0-dev
webron Oct 8, 2020
d8d8132
Added words relating to adopting semantics of JSON Schema (#2330)
darrelmiller Oct 14, 2020
88e533a
fix typo in release history table
MikeRalphson Oct 15, 2020
2eeb16d
fix link to style values in serialization table
MikeRalphson Oct 29, 2020
180edfc
Merge pull request #2375 from MikeRalphson/v3.1-fix-rc
MikeRalphson Nov 5, 2020
2f1e906
Merge pull request #2388 from MikeRalphson/styleValuesLink
MikeRalphson Nov 5, 2020
a1bdb38
Merge pull request #2256 from MikeRalphson/oai-prefix-31
MikeRalphson Nov 5, 2020
33a83e7
Fix misspelling of a keyword in text (#2389)
hkosova Nov 5, 2020
14121a1
Update wording that referred to the year 2019 as the current year (#2…
hkosova Nov 5, 2020
05de2c4
Added link to JSON Schema Validation docs explain which formats are i…
InfoSec812 Nov 5, 2020
99eabdf
Update 3.1.0.md (#2405)
greatvovan Nov 12, 2020
862a8e3
long descriptions are cool too (#2408)
philsturgeon Nov 19, 2020
a50af3a
Unescaped Slashes Aint Welcome Around 'Ere (#2218)
philsturgeon Dec 3, 2020
1f11d02
Add missing field and use same summaries in Request Body Examples. (#…
q-uint Jan 7, 2021
1cd5687
Add missing schema type in Operation Object YAML Example. (#2361)
q-uint Jan 7, 2021
478607b
OAS schema dialect clarifications (#2399)
MikeRalphson Jan 7, 2021
73098f2
Update JSON Schema Draft to 2020-12 and make $ref resolution rules ex…
MikeRalphson Jan 21, 2021
616ef88
Clean-up wording about $refs in responsesObjects, fixes #1679 (#2442)
MikeRalphson Jan 21, 2021
5c8a0b6
fix: two typos in versions/3.1.0.md (#2452)
MikeRalphson Feb 4, 2021
7ee1ca2
Fix, clarify, and simplify content type schemas (#2351)
handrews Feb 11, 2021
d6443c1
3.1.0 release prep (#2461)
webron Feb 15, 2021
8b97717
reframing `user` as `author` (#2463)
earth2marsh Feb 16, 2021
f9e313d
Merge branch 'master' into v3.1.0-dev
webron Feb 16, 2021
547ca88
fixed the dash character
webron Feb 16, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,32 +11,28 @@ The OpenAPI Specification (OAS) defines a standard, programming language-agnosti

Use cases for machine-readable API definition documents include, but are not limited to: interactive documentation; code generation for documentation, clients, and servers; and automation of test cases. OpenAPI documents describe an APIs services and are represented in either YAML or JSON formats. These documents may either be produced and served statically or be generated dynamically from an application.

The OpenAPI Specification does not require rewriting existing APIs. It does not require binding any software to a service the service being described may not even be owned by the creator of its description. It does, however, require the capabilities of the service be described in the structure of the OpenAPI Specification. Not all services can be described by OpenAPI this specification is not intended to cover every possible style of HTTP APIs, but does include support for [REST APIs](https://en.wikipedia.org/wiki/Representational_state_transfer). The OpenAPI Specification does not mandate a specific development process such as design-first or code-first. It does facilitate either technique by establishing clear interactions with a HTTP API.
The OpenAPI Specification does not require rewriting existing APIs. It does not require binding any software to a service the service being described may not even be owned by the creator of its description. It does, however, require the capabilities of the service be described in the structure of the OpenAPI Specification. Not all services can be described by OpenAPI this specification is not intended to cover every possible style of HTTP APIs, but does include support for [REST APIs](https://en.wikipedia.org/wiki/Representational_state_transfer). The OpenAPI Specification does not mandate a specific development process such as design-first or code-first. It does facilitate either technique by establishing clear interactions with a HTTP API.

This GitHub project is the starting point for OpenAPI. Here you will find the information you need about the OpenAPI Specification, simple examples of what it looks like, and some general information regarding the project.

## Current Version - 3.0.3
## Current Version - 3.1.0

The current version of the OpenAPI specification is [OpenAPI Specification 3.0.3](versions/3.0.3.md).

## Current Release Candidate Version - 3.1.0-RC1

We invite the community to review and provide feedback for the current release candidate ([OpenAPI Specification 3.1.0-RC1](versions/3.1.0.md). Changes related to the upcoming 3.1.0 release should be submitted at [the development branch](https://github.com/OAI/OpenAPI-Specification/tree/v3.1.0-dev).
The current version of the OpenAPI specification is [OpenAPI Specification 3.1.0](versions/3.1.0.md).

### Previous Versions

This repository also contains the [OpenAPI Specification 2.0](versions/2.0.md), which is identical to the Swagger 2.0 specification before it was renamed to "OpenAPI Specification", as well as the Swagger 1.2 and Swagger 2.0 specifications.
This repository also contains all [previous versions](versions).

Each folder in this repository, such as [examples](examples) and [schemas](schemas), should contain folders pertaining to the current and previous versions of the specification.

## See It in Action

If you just want to see it work, check out the [list of current examples](examples/v3.0).
If you just want to see it work, check out the [list of current examples](examples).

## Tools and Libraries

Looking to see how you can create your own OpenAPI definition, present it, or otherwise use it? Check out the growing
[list of 3.0 implementations](IMPLEMENTATIONS.md).
[list of implementations](IMPLEMENTATIONS.md).

## Participation

Expand All @@ -48,7 +44,7 @@ The TSC holds weekly web conferences to review open pull requests and discuss op

The OpenAPI Initiative encourages participation from individuals and companies alike. If you want to participate in the evolution of the OpenAPI Specification, consider taking the following actions:

* Review the [current specification](versions/3.0.3.md). The human-readable markdown file _is the source of truth_ for the specification.
* Review the [current specification](versions/3.1.0.md). The human-readable markdown file _is the source of truth_ for the specification.
* Review the [development](DEVELOPMENT.md) process so you understand how the spec is evolving.
* Check the [issues](https://github.com/OAI/OpenAPI-Specification/issues) and [pull requests](https://github.com/OAI/OpenAPI-Specification/pulls) to see if someone has already documented your idea or feedback on the specification. You can follow an existing conversation by subscribing to the existing issue or PR.
* Create an issue to describe a new concern. If possible, propose a solution.
Expand Down
Loading