Add cors rule in request/response for Cosmos DB #10204
Merged
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
[Staging] Swagger Validation Report
❌ |
| Rule | Message |
|---|---|
|
The new version has a new property 'cors' in response that was not found in the old version. New: Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json#L5245:7 Old: Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json#L5213:7 |
|
The new version has a new property 'cors' in response that was not found in the old version. New: Microsoft.DocumentDB/stable/2020-04-01/cosmos-db.json#L5112:7 Old: Microsoft.DocumentDB/stable/2020-04-01/cosmos-db.json#L5080:7 |
️️✔️LintDiff [Detail]
️✔️Validation passes for LintDiff.
️️✔️Avocado [Detail]
️✔️Validation passes for Avocado.
|
Azure Pipelines successfully started running 1 pipeline(s). |
Azure CLI Extension Generation - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-sdk-for-go - Release
|
azure-sdk-for-java - Release
|
azure-sdk-for-js - Release
|
azure-sdk-for-net - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-sdk-for-python - Release
|
Trenton Generation - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-sdk-for-python-track2 - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
This was referenced Jul 20, 2020
|
Can one of the admins verify this patch? |
yungezz
reviewed
Jul 23, 2020
| @@ -5351,6 +5383,10 @@ | |||
| "description": "The object representing the policy for taking backups on an account.", | |||
| "type": "object", | |||
| "$ref": "#/definitions/BackupPolicy" | |||
| }, | |||
| "cors": { | |||
There was a problem hiding this comment.
adding optional property also need version bump https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#api-changes-that-require-a-version-change
There was a problem hiding this comment.
adding property in output is breaking change, which requires version bump
There was a problem hiding this comment.
Hi @yungezz, this property has been available to users in production for some time, but was undocumented in swagger. We cannot add a new API version and restrict it as only available in that version because we could break users currently consuming the property. Should we add a new API version and document it there even if it remains available in previous versions?
There was a problem hiding this comment.
thanks for sharing, @shurd , just confirm, this PR is a fixing of Swagger bug actually right, not to introducing new property.
MehaKaushik
reviewed
Jul 23, 2020
...anager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBDatabaseAccountCreateMax.json
Outdated
Show resolved
Hide resolved
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
@yungezz can you please take another look at this? As noted, this is fixing a swagger bug to match what is currently in production. |
yungezz
approved these changes
Aug 3, 2020
yungezz
added
the
Approved-BreakingChange
|
approve since this is Swagger bug fixing PR. hi @shurd is this PR ready to merge? |
|
hi @yungezz this is ready to be merged |
innosam
pushed a commit
to innosam/azure-rest-api-specs
that referenced
this pull request
Aug 17, 2020
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.
This change adds the existing "cors" property to most recent api versions. This change has been present in our service for a while, but was overlooked when originally adding the swagger. The two API versions being updated do not yet have wide usage.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.
Please follow the link to find more details on PR review process.