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

v3.1.0-rc0 Release #2251

Merged
merged 41 commits into from
Jun 18, 2020
Merged

v3.1.0-rc0 Release #2251

merged 41 commits into from
Jun 18, 2020

Commits on Oct 8, 2018

  1. 3.1.0 prep

    webron committed Oct 8, 2018
    Configuration menu
    Copy the full SHA
    7a5b183 View commit details
    Browse the repository at this point in the history
  2. Update README

    webron committed Oct 8, 2018
    Configuration menu
    Copy the full SHA
    77f86eb View commit details
    Browse the repository at this point in the history

Commits on Oct 18, 2018

  1. Configuration menu
    Copy the full SHA
    e985f13 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    eb92123 View commit details
    Browse the repository at this point in the history
  3. Merge pull request #1715 from MikeRalphson/specext-oas

    Note that specification extensions beginning x-oas- are reserved
    webron authored Oct 18, 2018
    Configuration menu
    Copy the full SHA
    3083f1a View commit details
    Browse the repository at this point in the history
  4. Merge pull request #1714 from MikeRalphson/discrim-ext

    Allow specification extensions in discriminator object
    webron authored Oct 18, 2018
    Configuration menu
    Copy the full SHA
    334cf53 View commit details
    Browse the repository at this point in the history

Commits on Feb 6, 2019

  1. Configuration menu
    Copy the full SHA
    d27bb1c View commit details
    Browse the repository at this point in the history

Commits on Feb 7, 2019

  1. Merge pull request #1764 from MikeRalphson/v3.1-mutualTLS

    security; add new securityScheme type of mutualTLS
    webron authored Feb 7, 2019
    Configuration menu
    Copy the full SHA
    a76dad5 View commit details
    Browse the repository at this point in the history

Commits on Feb 28, 2019

  1. 832 add info.summary (#1779)

    * Fix: #832. Add info.summary.
    
    * Fix: summary is shord, description is verbose.
    
    Be consistent with other definitions of summary and description.
    ioggstream authored and darrelmiller committed Feb 28, 2019
    Configuration menu
    Copy the full SHA
    5f6a25a View commit details
    Browse the repository at this point in the history

Commits on Jun 21, 2019

  1. fix OIDC url and OAuth2 requirements

    Signed-off-by: Axel Nennker <[email protected]>
    AxelNennker committed Jun 21, 2019
    Configuration menu
    Copy the full SHA
    5044418 View commit details
    Browse the repository at this point in the history

Commits on Aug 6, 2019

  1. Merge pull request #1959 from AxelNennker/fix_OICD_and_OAuth2

    fix OIDC url and OAuth2 requirements
    MikeRalphson authored Aug 6, 2019
    Configuration menu
    Copy the full SHA
    192aafe View commit details
    Browse the repository at this point in the history

Commits on Oct 21, 2019

  1. Update Schema Object to proper JSON Schema

    Phil Sturgeon committed Oct 21, 2019
    Configuration menu
    Copy the full SHA
    ac236d1 View commit details
    Browse the repository at this point in the history

Commits on Oct 25, 2019

  1. update vocab and arbitrary props

    Phil Sturgeon committed Oct 25, 2019
    Configuration menu
    Copy the full SHA
    f8f92ed View commit details
    Browse the repository at this point in the history

Commits on Oct 28, 2019

  1. another go at arbitrary keywords

    Phil Sturgeon committed Oct 28, 2019
    Configuration menu
    Copy the full SHA
    e121405 View commit details
    Browse the repository at this point in the history

Commits on Oct 29, 2019

  1. feedback from @handrews

    Phil Sturgeon committed Oct 29, 2019
    Configuration menu
    Copy the full SHA
    5905f45 View commit details
    Browse the repository at this point in the history

Commits on Nov 27, 2019

  1. Support style, explode, allowReserved encoding for multipart/form-data (

    #2066)
    
    * Extend style, explode, allowReserved in encoding to multipart-formdata (#2018)
    
    * Update versions/3.1.0.md
    
    Co-Authored-By: Ron <[email protected]>
    
    * Replace details of multipart/form-data format with referce to RFC 7578
    
    * Update versions/3.1.0.md
    
    Co-Authored-By: Darrel <[email protected]>
    Mike Kistler and darrelmiller committed Nov 27, 2019
    Configuration menu
    Copy the full SHA
    0ec2c73 View commit details
    Browse the repository at this point in the history

Commits on Jan 9, 2020

  1. default should match json schema

    Phil Sturgeon committed Jan 9, 2020
    Configuration menu
    Copy the full SHA
    4822592 View commit details
    Browse the repository at this point in the history
  2. removed json schema keyworld list, its just all of em.

    Phil Sturgeon committed Jan 9, 2020
    Configuration menu
    Copy the full SHA
    d67f350 View commit details
    Browse the repository at this point in the history
  3. redundant $ref reference

    Phil Sturgeon committed Jan 9, 2020
    Configuration menu
    Copy the full SHA
    bb9a6f2 View commit details
    Browse the repository at this point in the history
  4. Merge pull request #1977 from philsturgeon/json-schema-update

    Update Schema Objects to JSON Schema Draft 2019-09
    webron authored Jan 9, 2020
    Configuration menu
    Copy the full SHA
    e3c236a View commit details
    Browse the repository at this point in the history

Commits on Jan 10, 2020

  1. Correct Styles Values for spaceDelimited and pipeDelimited, as based …

    …on Style Examples, they support objects.
    Arhimenrius committed Jan 10, 2020
    Configuration menu
    Copy the full SHA
    fd39bcd View commit details
    Browse the repository at this point in the history

Commits on Jan 16, 2020

  1. Add support for webhooks as a top-level element (#2103)

    * Add webhooks as a top-level element to the spec
    
    * Add the changes from #2048 and signpost webhooks
    
    * Add an example of webhooks
    
    * Relocate and expand on webhooks section following feedback
    
    * Better wording to describe expectations on API consumers
    
    * Clearer wording for why the paths element is here
    
    * Update language to make callbacks clearer
    lornajane authored and darrelmiller committed Jan 16, 2020
    Configuration menu
    Copy the full SHA
    61f9d7e View commit details
    Browse the repository at this point in the history

Commits on Feb 6, 2020

  1. Align the OAS 3.1 nullable language with the 3.0.3 (#2115)

    This adapts the language from PR #2046, with minimal wording tweaks
    to account for type now being able to have multiple values (type arrays).
    handrews authored Feb 6, 2020
    Configuration menu
    Copy the full SHA
    3cb92bd View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    c37a305 View commit details
    Browse the repository at this point in the history
  3. Reference Object and Schema Object use of $ref updates for 2019-09 / …

    …OAS 3.1 (#2107)
    
    * Checkpoint of draft
    
    * Fix typo.
    
    Co-Authored-By: Darrel <[email protected]>
    
    * Fix plural anchor
    
    Co-Authored-By: Mike Ralphson <[email protected]>
    
    * Remove superfluous specification
    
    Co-Authored-By: Phil Sturgeon <[email protected]>
    
    Co-authored-by: Darrel <[email protected]>
    Co-authored-by: Mike Ralphson <[email protected]>
    Co-authored-by: Phil Sturgeon <[email protected]>
    4 people authored Feb 6, 2020
    Configuration menu
    Copy the full SHA
    92a9104 View commit details
    Browse the repository at this point in the history

Commits on Feb 21, 2020

  1. Configuration menu
    Copy the full SHA
    c376bef View commit details
    Browse the repository at this point in the history

Commits on Feb 27, 2020

  1. Configuration menu
    Copy the full SHA
    70ecce7 View commit details
    Browse the repository at this point in the history

Commits on Mar 11, 2020

  1. Configuration menu
    Copy the full SHA
    c6415fe View commit details
    Browse the repository at this point in the history

Commits on Mar 19, 2020

  1. Make paths object optional (#1781)

    * Make paths object optional
    
    * Adding reusable Path Item Objects
    
    Under `components`
    
    * Adopt DM's suggested change to OpenAPI doc definition
    
    * Cleanup use of specification and definition where we mean document
    
    * multipartite>composite, define ACL
    
    * Add ' | Reference Object' to callbacks/webhooks
    
    Co-authored-by: Ron <[email protected]>
    MikeRalphson and webron authored Mar 19, 2020
    Configuration menu
    Copy the full SHA
    a6b99bc View commit details
    Browse the repository at this point in the history
  2. Fwd port v3.0.3 dev to v3.1.0 dev (#2163)

    * fix typo in Callback Object
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * retain typo in v3.0.2; fix for v3.0.3 (#1899)
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * 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 <[email protected]>
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * Ron's wording for Darrels feedback
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * ted updates
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * Replace 'application' by 'API' within the 'Info Object' definition. (#2004)
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * 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.
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * yaml.org supports https, but www.yaml.org is misconfigured
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * Updated text for OperationRef
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * 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 <[email protected]>
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * Make ABNF for runtime expressions complete
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * 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.1.0.md
    
    Co-authored-by: Ron <[email protected]>
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * Clarify constraints on Security Scheme Object Scheme Property (#1880)
    
    * Wording around scheme extensions
    
    * Clarified that securitySchemeScheme is only a SHOULD be registered scheme
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * fix difference between yaml and json in Response Object Examples
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * Server Variable Object clarifications (#1809)
    
    * Server Variable Object clarifications
    
    * Toned language down for proper semver versioning
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * Fix formatting errors in example (#2132)
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * Update 3.0.3 for release (#2149)
    
    * Update README.md for release
    
    * Update release date for 3.0.3
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * Update versions/3.1.0.md
    
    Co-Authored-By: Darrel <[email protected]>
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * Fixed typo
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * explicit 'forward slash'
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * fix #2053: `style` keyword is not supported inside Schema object
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * OpenAPI not Open API
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * backticks
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * 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 <[email protected]>
    
    Co-authored-by: Ron <[email protected]>
    Co-authored-by: Mike Ralphson <[email protected]>
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * Update 3.1.0.md
    
    fixed typo
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * Removed confusing comment
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * 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 <[email protected]>
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * The examples keyword is not supported inside schema (#2042)
    
    * examples not supported inside schema
    
    * figured it out
    
    * a tiny little edit
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * Fix 'Security Scheme Object' definition with OAuth 2.0 grant types. (#2006)
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    * Fix formatting errors in example (#2132)
    
    Signed-off-by: Mike Ralphson <[email protected]>
    
    Co-authored-by: seiya <[email protected]>
    Co-authored-by: Adam Leventhal <[email protected]>
    Co-authored-by: Sebastián Ramírez <[email protected]>
    Co-authored-by: Ron <[email protected]>
    Co-authored-by: Phil Sturgeon <[email protected]>
    Co-authored-by: Patrice Krakow <[email protected]>
    Co-authored-by: Ted Epstein <[email protected]>
    Co-authored-by: Darrel Miller <[email protected]>
    Co-authored-by: Carsten Brandt <[email protected]>
    Co-authored-by: Henry Andrews <[email protected]>
    Co-authored-by: Sergej <[email protected]>
    Co-authored-by: nasa9084 <[email protected]>
    Co-authored-by: Erik Wilde <[email protected]>
    14 people authored Mar 19, 2020
    Configuration menu
    Copy the full SHA
    b5a15df View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    b45d0d8 View commit details
    Browse the repository at this point in the history

Commits on Mar 26, 2020

  1. Configuration menu
    Copy the full SHA
    cafadc9 View commit details
    Browse the repository at this point in the history

Commits on Apr 9, 2020

  1. Merge pull request #2101 from Arhimenrius/correct-style-values-types

    Correct Styles Values for spaceDelimited and pipeDelimited, as based …
    earth2marsh authored Apr 9, 2020
    Configuration menu
    Copy the full SHA
    6abda3b View commit details
    Browse the repository at this point in the history
  2. HTTP not REST (#1946)

    Co-authored-by: Phil Sturgeon <[email protected]>
    philsturgeon and Phil Sturgeon authored Apr 9, 2020
    Configuration menu
    Copy the full SHA
    1a8d44f View commit details
    Browse the repository at this point in the history

Commits on May 6, 2020

  1. Missing updates

    While going over the changes for the release notes, found two issues:
    - The TOC entry for `Relative references in URIs` was not modified to match the change in the spec.
    - The `Paths Object` had an extra sentence that should have not been there (referencing sub-documents and overlays).
    webron authored May 6, 2020
    Configuration menu
    Copy the full SHA
    d5b65bb View commit details
    Browse the repository at this point in the history

Commits on May 7, 2020

  1. Merge pull request #2224 from OAI/Missing-updates

    Missing updates
    MikeRalphson authored May 7, 2020
    Configuration menu
    Copy the full SHA
    3678d30 View commit details
    Browse the repository at this point in the history

Commits on May 14, 2020

  1. Remove boolean compatibility for exclusive* (#2226)

    This brings exclusiveMinimum, exclusiveMaximum, minimum, and
    maximum, into full modern JSON Schema compatibility.
    
    There are no edits directly mentioning minimum and maximum,
    but removing the boolean form simplifies their processing
    by making it context-independent.
    handrews authored May 14, 2020
    Configuration menu
    Copy the full SHA
    ece5497 View commit details
    Browse the repository at this point in the history

Commits on May 28, 2020

  1. Update "format" and "content*" for new JSON Schema (#2200)

    * Update "format" and "content*" for new JSON Schema
    
    This removes OAS formats and examples that are now superfluous
    as they are part of the 2019-09 JSON Schema draft.
    
    Similarly it deprecates the "byte" and "binary" formats in favor
    of JSON Schema's "contentEncoding" and "contentMediaType" keywords,
    and updates various related exapmles and other guidance.
    
    It also removes confusingly blank rows in the OAS format table.
    
    * "format" is an annotation
    
    * Fix broken table, type, in Encoding Object
    
    Broke some things while updating for "content*"
    
    * Fix format of `format`
    
    Backticks, not double quotes.
    
    * Remove unneeded detail on "format"
    
    This was just duplicating info from the JSON Schema spec.
    
    Co-authored-by: Darrel <[email protected]>
    
    * Remove "byte" and "binary" formats altogether.
    
    Instead of just deprecating.  The "content*" keywords now
    cover these use cases.
    
    * Harmonize JSON Schema content* + Media Type Object
    
    Includes harmonizing with the Encoding Object.  In general,
    OpenAPI objects set the media type, although there is a case
    for `contentMediaType` with multipart/form-data.  Otherwise,
    `contentEncoding` replaces the now-removed custom formats.
    
    A possibly controversial change is to indicate unencoded binary
    data by omitting `type` (or omitting the schema altogether), as
    binary data does not conform to JSON string requirements.
    
    This could still be done with `type: string` if that is preferred.
    It's going to be a bit weird either way.
    
    I can add wording in the next JSON Schema draft to clarify
    whichever approach makes more sense.
    
    * Fix typos from review
    
    * Remove stray {}
    
    * Fix inconsistencies contentMediaType and Encoding Object
    
    Co-authored-by: Darrel <[email protected]>
    handrews and darrelmiller authored May 28, 2020
    Configuration menu
    Copy the full SHA
    69662e4 View commit details
    Browse the repository at this point in the history
  2. [3.1.0-dev] drop OAS semver requirement (#2243)

    * drop OAS semver requirement
    
    * Update versions/3.1.0.md
    
    Co-authored-by: Darrel <[email protected]>
    MikeRalphson and darrelmiller authored May 28, 2020
    Configuration menu
    Copy the full SHA
    835a18f View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    ee77d2d View commit details
    Browse the repository at this point in the history

Commits on Jun 18, 2020

  1. Configuration menu
    Copy the full SHA
    3a96dfe View commit details
    Browse the repository at this point in the history