v3.0.2 Release #1700
Merged
v3.0.2 Release #1700
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
Fix nvm install on travis
… Invalid' to 'Method Not Allowed'
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.
Removing type confusion
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
Fix callback key expression example.
…cated Add missing description of default value
fix wording on who supplies the default value for a server variable
Translate examples
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.
Make allowEmptyValue NOT RECOMMENDED
* 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.
This reverts commit 4c79d31.
This reverts commit 3e7d0a8.
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`
3.0.2 Release Prep
webron
changed the title
|
+1 |
earth2marsh
requested review from
earth2marsh
and removed request for
earth2marsh
MikeRalphson
approved these changes
Oct 4, 2018
Update release date
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Common Nameto reduce potential confusion.Server Variable Object'sdefaultfield.operationIdis case sensitive.Parameter Object'sdeprecatedfield isfalse.Parameter Object'sallowEmptyValuefield as it will be removed in a future version.Media Type Object'sschemafield.Responses Object's response codes field description.Schema Object'sadditionalPropertiesfield has a default value oftrue.Discriminator Objectdescription.Security Scheme Objectdescription to include reference to the use of API Keys in cookies.Security Requirement Object.@OAI/tsc - please review and vote.