Fwd port v3.0.3 dev to v3.1.0 dev#2163

Merged

webron merged 31 commits into

OAI:v3.1.0-devfrom

MikeRalphson:fwd-port-v3.0.3-dev-to-v3.1.0-dev

Mar 19, 2020

MikeRalphson commented Feb 27, 2020 •

edited

Loading

Member

This PR aims to forward-port the changes made in the v3.0.3-dev branch versions/3.0.3.md file to the v3.1.0-dev branch by making (where possible) equivalent commits to versions/3.1.0.md.

Many of the patches did not automatically apply, so some conflict resolution was necessary.

The scripts used are (for now) located here, but could be brought "in-house" if wanted.

seiyab and others added 30 commits

February 24, 2020 16:50


          fix typo in Callback Object

64806a8

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


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

39685b3

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


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

52c76a7

* 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>
Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


          Ron's wording for Darrels feedback

3318c55

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


          ted updates

cc2b6bd

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


          Replace 'application' by 'API' within the 'Info Object' definition. (O…

12f4f57

…AI#2004)

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


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

0a15e65

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

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

* Update OAI#1830 fix with suggestion from Darrel

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

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


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

67fb5c4

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


          Updated text for OperationRef

4a41994

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


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

a879287

* fix a typo in the Security Filtering section

* Security filtering slight reword

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


          Make ABNF for runtime expressions complete

8f4c279

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


          Explain unclear semantics of property $ref in Path Item Object (OAI…

7a205a1

…#1964)

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

Currently, as explained in OAI#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 OAI#1038 to make it more clear.

* Update versions/3.1.0.md

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


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

60dc2b2

* Wording around scheme extensions

* Clarified that securitySchemeScheme is only a SHOULD be registered scheme

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


          fix difference between yaml and json in Response Object Examples

5e79257

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


          Server Variable Object clarifications (OAI#1809)

e500f92

* Server Variable Object clarifications

* Toned language down for proper semver versioning

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


          Fix formatting errors in example (OAI#2132)

ab6a532

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


          Update 3.0.3 for release (OAI#2149)

30196ce

* Update README.md for release

* Update release date for 3.0.3

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


          Update versions/3.1.0.md

4f3d63c

Co-Authored-By: Darrel <darrmi@microsoft.com>
Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


          Fixed typo

4effc01

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


          explicit 'forward slash'

d98d7a0

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


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

c4d6464

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


          OpenAPI not Open API

d221d97

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


          backticks

310b65c

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


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

8b31694

* 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>
Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


          Update 3.1.0.md

a7b6c76

fixed typo

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


          Removed confusing comment

5e2a7d7

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


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

996c413

)

* Referencing issue OAI#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 OAI#513, adjusting language and removing examples

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

* removed unnecessary example header

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


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

f77f7f5

* examples not supported inside schema

* figured it out

* a tiny little edit

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


          Fix 'Security Scheme Object' definition with OAuth 2.0 grant types. (O…

4e42746

…AI#2006)

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>


          Fix formatting errors in example (OAI#2132)

cc50e24

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>

MikeRalphson requested a review from tedepstein

February 27, 2020 18:05

MikeRalphson commented Feb 27, 2020

Member Author

If @seiyab @tiangolo @patricekrakow @cebe @sergej2705 @nasa9084 and @dret also have time to check that their changes have been correctly merged, that would be a great help.

philsturgeon reviewed

View reviewed changes

versions/3.1.0.md

    
              <a name="infoDescription"></a>description | `string` | A verbose explanation of the application. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.

              <a name="infoTitle"></a>title | `string` | **REQUIRED**. The title of the API.

              <a name="infoSummary"></a>summary | `string` | A short summary of the API.

              <a name="infoDescription"></a>description | `string` | A short description of the API. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.

philsturgeon Feb 27, 2020

Contributor

just double checking that we want "short" on both summary and description?

philsturgeon approved these changes

View reviewed changes

handrews approved these changes

View reviewed changes

dret commented Feb 27, 2020

Contributor

not quite sure where and what to check, but i am sure it's fine. it was just editorial.

seiyab commented Feb 28, 2020

Contributor

I'll check my change by this Sunday.

nasa9084 commented Feb 28, 2020

Contributor

LGTM for my change

seiyab commented Feb 28, 2020

Contributor

LGTM.

FYI:
#1795 seems to meld into another commit.
I don't mind.

tiangolo approved these changes

View reviewed changes

tiangolo left a comment

Contributor

Thanks for pinging me!

LGTM 🚀

webron approved these changes

View reviewed changes

seiyab approved these changes

View reviewed changes

cebe approved these changes

View reviewed changes


          Merge branch 'v3.1.0-dev' into fwd-port-v3.0.3-dev-to-v3.1.0-dev

e007057

webron merged commit b5a15df into OAI:v3.1.0-dev

PhilYue mentioned this pull request

v3.1.0-rc1 Release (#2370) PhilYue/OpenAPI-Specification#1

Merged

philsturgeon mentioned this pull request

long descriptions are cool too #2408

Merged

MikeRalphson mentioned this pull request

scripts: add fwdport/fwdabort.sh for forward porting commits between branches #2597

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

+4 more reviewers

Labels

None yet