[Hub Generated] Review request for Microsoft.KeyVault to add version stable/2019-09-01 #12618
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
|
Hi, @jiacheng-L Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The new version has a new property 'metricSpecifications' in response that was not found in the old version. New: Microsoft.KeyVault/stable/2019-09-01/providers.json#L135:7 Old: Microsoft.KeyVault/stable/2019-09-01/providers.json#L135:7 |
️⚠️LintDiff: 3 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
- Linted configuring files (Based on target branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
| Rule | Message |
|---|---|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: ignoreMissingVnetServiceEndpoint Location: Microsoft.KeyVault/stable/2019-09-01/keyvault.json#L1793 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: fillGapWithZero Location: Microsoft.KeyVault/stable/2019-09-01/providers.json#L217 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: toBeExportedForShoebox Location: Microsoft.KeyVault/stable/2019-09-01/providers.json#L238 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️[Staging] SDK Track2 Validation: 138 Warnings warning [Detail]
Only 10 items are listed, please refer to log for more details.
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"keyvault/resource-manager/readme.md", "tag":"package-preview-2020-04", "details":"The schema 'CloudError' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"keyvault/resource-manager/readme.md", "tag":"package-preview-2020-04", "details":"The schema 'CloudErrorBody' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"keyvault/resource-manager/readme.md", "tag":"package-preview-2020-04", "details":"The schema 'Sku' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"keyvault/resource-manager/readme.md", "tag":"package-preview-2020-04", "details":"The schema 'AccessPolicyEntry' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"keyvault/resource-manager/readme.md", "tag":"package-preview-2020-04", "details":"The schema 'Permissions' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"keyvault/resource-manager/readme.md", "tag":"package-preview-2020-04", "details":"The schema 'VaultProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"keyvault/resource-manager/readme.md", "tag":"package-preview-2020-04", "details":"The schema 'VaultPatchProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"keyvault/resource-manager/readme.md", "tag":"package-preview-2020-04", "details":"The schema 'VaultAccessPolicyProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"keyvault/resource-manager/readme.md", "tag":"package-preview-2020-04", "details":"The schema 'DeletedVaultProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"keyvault/resource-manager/readme.md", "tag":"package-preview-2020-04", "details":"The schema 'VaultCreateOrUpdateParameters' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
This was referenced Jan 25, 2021
jiacheng-L
requested review from
heaths,
jlichwa and
RandalliLama
as code owners
This was referenced Jan 25, 2021
JeffreyRichter
added
the
Approved-BreakingChange
JeffreyRichter
approved these changes
Jan 25, 2021
heaths
reviewed
Jan 27, 2021
| @@ -133,6 +133,13 @@ | |||
| "items": { | |||
| "$ref": "#/definitions/LogSpecification" | |||
| } | |||
| }, | |||
| "metricSpecifications": { | |||
There was a problem hiding this comment.
Why are you adding a new property to a GA'd version? This could cause problems with existing clients, including data loss for input-output models.
/cc @JeffreyRichter
There was a problem hiding this comment.
@heaths This property is reported by the S360 swagger correctness report, which is missing defined in swagger spec in the 2019-09-01 version, but it exists in traffic payload
jlichwa
approved these changes
Jan 27, 2021
|
hi @ArcturusZhang could you pls help to confirm impact to Go SDK? thanks. |
|
hi @jiacheng-L, could you pls look at same comments as in PR #12619? thanks |
Replied on those |
ping |
yungezz
approved these changes
Feb 2, 2021
|
@yungezz this PR does not introduce breaking changes to go SDK. |
|
For python, the PR is ok |
|
from https://github.com/Azure/azure-rest-api-specs/pull/12618/checks?check_run_id=1852779691, APIDocPreview task finished |
This was referenced Feb 8, 2021
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
…stable/2019-09-01 (Azure#12618)
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 is a PR generated at OpenAPI Hub. You can view your work branch via this link.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
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.
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
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.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.