-
Notifications
You must be signed in to change notification settings - Fork 5.3k
[Hub Generated] Review request for Microsoft.KeyVault to add version preview/2021-06-01-preview #20457
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
Draft
brihicks-653
wants to merge
1
commit into
Azure:main
Choose a base branch
from
brihicks-653:release-keyvault-Microsoft.KeyVault-2021-06-01-preview
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Conversation
This file contains hidden or 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, @brihicks-653 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. [email protected] |
Swagger Validation Report
|
compared swaggers (via Oad v0.9.7)] | new version | base version |
---|---|---|
2021-06-01-preview | 2021-06-01-preview(3059c30) | 2021-06-01-preview(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-preview-2021-06 | package-preview-2021-06(3059c30) | package-preview-2021-06(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json#L306 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json#L312 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json#L318 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json#L324 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L553 |
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L499 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json#L398 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json#L419 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json#L430 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Keys_CreateIfNotExist' Request Model: 'KeyCreateParameters' Response Model: 'Key' Location: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L14 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Secrets_CreateOrUpdate' Request Model: 'SecretCreateOrUpdateParameters' Response Model: 'Secret' Location: Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json#L14 |
|
The child tracked resource, 'keys' with immediate parent 'Vault', must have a list by immediate parent operation. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L511 |
|
The child tracked resource, 'versions' with immediate parent 'Key', must have a list by immediate parent operation. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L511 |
|
The child tracked resource, 'secrets' with immediate parent 'Vault', must have a list by immediate parent operation. Location: Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json#L428 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L438 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: exportable Location: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L482 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json#L302 |
|
'keyOps' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L374 |
|
'RotationPolicy' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L547 |
|
'KeyRotationPolicyAttributes' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L563 |
|
'LifetimeAction' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L584 |
|
'Trigger' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L597 |
|
'Action' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L610 |
|
'KeyReleasePolicy' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L627 |
|
The API version:2021-06-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L4 |
|
The API version:2021-06-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json#L4 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 73 Errors, 0 Warnings failed [Detail]
Test run on tag: package-preview-2021-06, operation coverage: 41/41, failed operations: 19Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
CLIENT_ERROR |
"statusCode: 404, errorCode: DeletedVaultNotFound, errorMessage: The specified deleted vault 'vaultname85hfal' does not exist. Ensure that the vault was indeed deleted and that it is in recoverable state. If soft delete was not enabled then the vault is permanently deleted. Follow this link for more information: https://go.microsoft.com/fwlink/?linkid=2149745" |
ASSERTION_ERROR |
"expected response code to be 2XX but found 404" |
CLIENT_ERROR |
"statusCode: 400, errorCode: InvalidApiVersionParameter, errorMessage: The api-version '2021-06-01-preview' is invalid. The supported versions are '2022-05-01, 2022-03-01-preview, 2022-01-01, 2021-04-01, 2021-01-01, 2020-10-01, 2020-09-01, 2020-08-01, 2020-07-01, 2020-06-01, 2020-05-01, 2020-01-01, 2019-11-01, 2019-10-01, 2019-09-01, 2019-08-01, 2019-07-01, 2019-06-01, 2019-05-10, 2019-05-01, 2019-03-01, 2018-11-01, 2018-09-01, 2018-08-01, 2018-07-01, 2018-06-01, 2018-05-01, 2018-02-01, 2018-01-01, 2017-12-01, 2017-08-01, 2017-06-01, 2017-05-10, 2017-05-01, 2017-03-01, 2016-09-01, 2016-07-01, 2016-06-01, 2016-02-01, 2015-11-01, 2015-01-01, 2014-04-01-preview, 2014-04-01, 2014-01-01, 2013-03-01, 2014-02-26, 2014-04'." |
ASSERTION_ERROR |
"expected response code to be 2XX but found 400" |
ENUM_MISMATCH |
"No enum match for: 2021-06-01-preview" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Standard" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Get" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: List" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Update" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Create" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Import" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Delete" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Recover" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Backup" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Restore" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Get" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: List" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Set" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Delete" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Recover" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Backup" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Restore" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Get" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: List" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Update" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Create" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Import" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Delete" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Recover" |
ENUM_CASE_MISMATCH |
"Enum does not match case for: Backup" |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️
SDK Track2 Validation: 0 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/3059c30cf425135f96f17c1355d24dca8c95bfa7/specification/keyvault/resource-manager/readme.md#tag-package-preview-2021-06">keyvault/resource-manager/readme.md#package-preview-2021-06
Rule | Message |
---|---|
"readme":"keyvault/resource-manager/readme.md", "tag":"package-preview-2021-06", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Aug 29, 2022
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.
ARM API Information (Control Plane)
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.