Skip to content

Commit

Permalink
OAS v3.0.3 Release (#2148)
Browse files Browse the repository at this point in the history
* 3.0.3 prep

* Update README.md

* Update README.md

* Removed confusing comment

* Updated text for OperationRef

* Clarified supported Ecma edition for regex

Added supported Ecma edition (5.1) for regular expressions in the link text and used the formal name: [Ecma-262 Edition 5.1](https://www.ecma-international.org/ecma-262/5.1/).

See also: #1687

* Make ABNF for runtime expressions complete

* json-schema.org and commonmark.org now support https

* Update 3.0.2.md

fixed typo

* Update 3.0.2.md

fixed typo

* Fixed typo

* Update 3.0.3.md

fixed typo

* Update 3.0.2.md

fixed typo

* explicit 'forward slash'

* add back quotes

* fix difference between yaml and json in Response Object Examples

* fix typo in Callback Object

* Update 3.0.2.md

* yaml.org supports https, but www.yaml.org is misconfigured

* allow, but discourage, requestBody for GET, HEAD, DELETE

* spelling error

* retain typo in v3.0.2; fix for v3.0.3 (#1899)

* Corrected pattern regex dialect link

* TSC 2019-10-03 Feedback

This sentance was meant to paraphrase semver for clarifty, but ended up suggesting a confusion situation where new things essentially cannot really happen.

@webron has context on this.

* Ron's wording for Darrels feedback

* ted updates

* backticks

* Improved callback examples

* fix #2053: `style` keyword is not supported inside Schema object

* Resolved undocumented nullable behavior (#2046)

* Resolved undocumented nullable behavior

OpenAPI Schema Objects and JSON Schema have a few fundamental differences, and this clears up a bit of confusion about one of them.

* Added ted updates from oct 31st TSC

Co-Authored-By: Ted Epstein <ted.epstein@reprezen.com>

* Update versions/3.0.3.md

Co-Authored-By: Darrel <darrmi@microsoft.com>

* Fix 'Security Scheme Object' definition with OAuth 2.0 grant types. (#2006)

* The examples keyword is not supported inside schema (#2042)

* examples not supported inside schema

* figured it out

* a tiny little edit

* Replace 'application' by 'API' within the 'Info Object' definition. (#2004)

* OpenAPI not Open API

* Revert "allow, but discourage, requestBody for GET, HEAD, DELETE"

* Clarify constraints on Security Scheme Object Scheme Property (#1880)

* Wording around scheme extensions

* Clarified that securitySchemeScheme is only a SHOULD be registered scheme

* Fix formatting errors in example (#2132)

* Server Variable Object clarifications (#1809)

* Server Variable Object clarifications

* Toned language down for proper semver versioning

* Path Templating Clarification - proposed fix for #1830.  (#1831)

* Proposed fix for #1830. Each variable expression in a path must have a corresponding path parameter.

* #1830 - Removed 'at least once' to defer the question about repeated references to a single path parameter.

* Update #1830 fix with suggestion from Darrel

@darrelmiller suggestions we use "template expression" instead of "variable expression" to align with RFC6570. Good idea.

* Clarify the spec to allow optional or unspecified OAuth scopes (#1888)

* Referencing issue #513. Clarify the spec to accommodate OAuth schemes where scope may be unspecified (optional scope) or where scope is not used at all.

* Removed the provision for default scope represented as empty string. This introduces some ambiguities in the Security Requirement Object that would need to be addressed.

* For #513, adjusting language and removing examples

For #513, adjusting language and removing examples as suggested by @webron.

* removed unnecessary example header

Co-authored-by: Ron <ron@swagger.io>

* Clarify empty Security Requirement Object usage and validity (#1886)

* Clarify empty Security Requirement Object usage and validity

* Reorder sentences to make clearer.

* Remove wrong text.

* Removed unneeded text.

Co-authored-by: Ron <ron@swagger.io>

* fix a typo in the Security Filtering section (#1837)

* fix a typo in the Security Filtering section

* Security filtering slight reword

Co-authored-by: Mike Ralphson <mike.ralphson@gmail.com>

* minor clarification for operationId usage in link objects (#1733)

* minor clarification

it's a bit confusing that both the id and the reference are called "operationId", so this tweak makes the text a bit more explicit.

* use right terminology

Co-Authored-By: Mike Ralphson <mike.ralphson@gmail.com>

Co-authored-by: Ron <ron@swagger.io>
Co-authored-by: Mike Ralphson <mike.ralphson@gmail.com>

* Explain unclear semantics of property `$ref` in Path Item Object (#1964)

* Explain unclear semantics of property `$ref` in Path Item Object

Currently, as explained in #1038 (comment) the description of `$ref` in [Path Item Object](https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/versions/3.0.2.md#pathItemObject) is unclear about the semantics behing it. I took the explaination from issue #1038 to make it more clear.

* Update versions/3.0.3.md

Co-authored-by: Ron <ron@swagger.io>

* Update 3.0.3 for release (#2149)

* Update README.md for release

* Update release date for 3.0.3

Co-authored-by: Darrel <darrmi@microsoft.com>
Co-authored-by: Mike Ralphson <mike.ralphson@gmail.com>
Co-authored-by: Sergej <sergej2705@users.noreply.github.com>
Co-authored-by: Seiya <r108338@yahoo.co.jp>
Co-authored-by: Alan Crosswell <alan@crosswell.us>
Co-authored-by: Rich Ellis <ricellis@users.noreply.github.com>
Co-authored-by: Phil Sturgeon <me@philsturgeon.uk>
Co-authored-by: nasa9084 <nasa9084@users.noreply.github.com>
Co-authored-by: Ted Epstein <ted.epstein@reprezen.com>
Co-authored-by: Patrice Krakow <patrice.krakow@gmail.com>
Co-authored-by: Marsh Gardiner <marsh.gardiner@gmail.com>
Co-authored-by: Henry Andrews <andrews_henry@yahoo.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
Co-authored-by: Erik Wilde <dret@users.noreply.github.com>
Co-authored-by: Carsten Brandt <mail@cebe.cc>
  • Loading branch information
16 people authored Feb 21, 2020
1 parent 149e6be commit b748a88
Show file tree
Hide file tree
Showing 2 changed files with 3,461 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ The OpenAPI Specification does not require rewriting existing APIs. It does not

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.2
## Current Version - 3.0.3

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

### Future Versions

[3.1.0](https://github.com/OAI/OpenAPI-Specification/tree/v3.1.0-dev) - The next MINOR version. Non-breaking changes should be submitted against this branch.

### Future Versions

Expand Down Expand Up @@ -48,7 +52,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.2.md). The human-readable markdown file _is the source of truth_ for the specification.
* Review the [current specification](versions/3.0.3.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 adding a comment to the existing issue or PR.
* Create an issue to describe a new concern. If possible, propose a solution.
Expand Down
Loading

0 comments on commit b748a88

Please sign in to comment.