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.0.2 Release #1700

Merged
merged 57 commits into from
Oct 8, 2018
Merged

v3.0.2 Release #1700

merged 57 commits into from
Oct 8, 2018

Conversation

webron
Copy link
Member

@webron webron commented Oct 3, 2018

Release Notes:

As a patch release, the following changes were made to improve the specification in terms of readability and accuracy. None of these modifications change the behavior of the spec.

  • Added clarification to case sensitivity of keys in maps.
  • Reworked the Data Type table, removing the Common Name to reduce potential confusion.
  • Clarified the description of the Server Variable Object's default field.
  • Fixed various examples.
  • Clarified operationId is case sensitive.
  • Clarified the default value of the Parameter Object's deprecated field is false.
  • Added recommendation to not use the Parameter Object's allowEmptyValue field as it will be removed in a future version.
  • Fixed the description of the Media Type Object's schema field.
  • Clarified the description of the Responses Object's response codes field description.
  • Clarified that the Schema Object's additionalProperties field has a default value of true.
  • Fixed a small wording issue in the Discriminator Object description.
  • Fixed the Security Scheme Object description to include reference to the use of API Keys in cookies.
  • Fixed the description of the Security Requirement Object.

@OAI/tsc - please review and vote.

webron and others added 30 commits December 15, 2017 08:25
3.0.2 - Security Scheme Object description missing cookie location for apiKey
Update Open API object to OpenAPI Object in 3.0.2
It is understood that most examples showcased in the OAS spec are snippets, not entire OAS documents. However some of those snippets would not be valid even if included in entire OAS documents. This PR is an attempt to fix some of those examples.

**List of changes**:
- added a `GeneralError` schema inside the `Components Object Example`
- split the `Example Object Example` into multiple examples
Fixed some invalid examples
Revise 405 Response Object description to follow the RFC7231 Specification 's definition
Updated text relating to wildcard status code responses to clarify intent
So many people were considering dateTime, etc to be an OpenAPI type that tool vendors were implementing functionality to normalize this.

mikunn/openapi-schema-to-json-schema#4

I too in the past have thought I was meant to use dateTime in the format, not date-time. Let's just get rid of this column, it serves no real purpose as far as I can tell.
Added wording to clarify case sensitivity rules.
Address #715 - State (explicitly) whether Open API schema object definitions are open or closed for extension.
Address #715 - State (explicitly) whether Open API schema object definitions are open or closed for extension. Add 'an' for readability.
Updated suggested text to simplify
State explicitly: `additionalProperties : true` is the default
…cated

Add missing description of default value
fix wording on who supplies the default value for a server variable
webron and others added 16 commits July 2, 2018 10:48
Remove colons from example headings
discriminator is now an object, not an attribute
Do not rely on auto-detection of fenced code block languages
Simple change to indicate that it is likely to be removed in a later revision.
* Pet Schema in the MediaTypes Examples and Schema Object Examples uses the camelCase notation(petType),
* While Pets from the Discriminator Object use snake_case (pet_type).
It's inconsistent.

I chose the camelCase notation because it's used for propertyNames by the OpenAPI specification itself.
Re-target two commits from 3.0.1.md to 3.0.2.md
Consistent use of property name in schema examples: `petType` vs `pet_type`
@webron webron requested a review from a team October 3, 2018 21:12
@webron webron changed the title [WIP] v3.0.2 Release - DO NOT MERGE v3.0.2 Release - VOTING PERIOD Oct 3, 2018
@usarid
Copy link
Contributor

usarid commented Oct 4, 2018

+1

@earth2marsh earth2marsh requested review from earth2marsh and removed request for earth2marsh October 4, 2018 02:06
Copy link
Member

@earth2marsh earth2marsh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@webron webron changed the title v3.0.2 Release - VOTING PERIOD v3.0.2 Release Oct 7, 2018
@webron webron merged commit 98138c7 into master Oct 8, 2018
@webron webron deleted the v3.0.2-dev branch April 23, 2020 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.