Azure key vault import keys json to 2021-04-01-preview #14367
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
|
Hi, @qinl-li 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 is adding a path that was not found in the old version. New: Microsoft.KeyVault/preview/2021-04-01-preview/keys.json#L13:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.KeyVault/preview/2021-04-01-preview/keys.json#L150:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.KeyVault/preview/2021-04-01-preview/keys.json#L210:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.KeyVault/preview/2021-04-01-preview/keys.json#L283:5 |
️⚠️LintDiff: 15 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- Linted configuring files (Based on target branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/preview/2021-04-01-preview/keys.json#L488 |
|
| 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-04-01-preview/keys.json#L14 |
|
| The child tracked resource, 'keys' with immediate parent 'Vault', must have a list by immediate parent operation. Location: Microsoft.KeyVault/preview/2021-04-01-preview/secrets.json#L299 |
|
| The child tracked resource, 'versions' with immediate parent 'Key', must have a list by immediate parent operation. Location: Microsoft.KeyVault/preview/2021-04-01-preview/secrets.json#L299 |
|
| The child tracked resource, 'accessPolicies' with immediate parent 'Vault', must have a list by immediate parent operation. Location: Microsoft.KeyVault/preview/2021-04-01-preview/secrets.json#L299 |
|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'Vault', must have a list by immediate parent operation. Location: Microsoft.KeyVault/preview/2021-04-01-preview/secrets.json#L299 |
|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'ManagedHsm', must have a list by immediate parent operation. Location: Microsoft.KeyVault/preview/2021-04-01-preview/secrets.json#L299 |
|
| The child tracked resource, 'secrets' with immediate parent 'Vault', must have a list by immediate parent operation. Location: Microsoft.KeyVault/preview/2021-04-01-preview/secrets.json#L299 |
|
| 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-04-01-preview/keys.json#L432 |
|
| '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-04-01-preview/keys.json#L374 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| 'PUT' operation 'Vaults_UpdateAccessPolicy' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L307 |
|
| 'PUT' operation 'PrivateEndpointConnections_Put' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L866 |
|
| 'PUT' operation 'MHSMPrivateEndpointConnections_Put' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.KeyVault/preview/2021-04-01-preview/managedHsm.json#L593 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1503 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1524 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1554 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1597 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1625 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/preview/2021-04-01-preview/managedHsm.json#L965 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/preview/2021-04-01-preview/managedHsm.json#L1100 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"keyvault/resource-manager/readme.md",
"tag":"package-preview-2021-04",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"keyvault/resource-manager/readme.md",
"tag":"package-preview-2021-04",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
The following errors/warnings exist before current PR submission:
|:speech_balloon: AutorestCore/Exception|"readme":"keyvault/resource-manager/readme.md",
"tag":"package-preview-2021-04",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Generation Artifacts
|
|
Hi @qinl-li, Your PR has some issues. Please fix the CI sequentially by following the order of
|
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
openapi-pipeline-app
bot
added
CI-BreakingChange-Go
and removed
CI-FixRequiredOnFailure
labels
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
…into Azure-KeyVault-Import-KeysJson-To-2021-04-01-Preview
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
NewApiVersionRequired reason: |
jlichwa
approved these changes
May 28, 2021
heaths
requested changes
May 28, 2021
| { | ||
| "$ref": "#/parameters/SubscriptionIdParameter" | ||
| }, | ||
| { |
There was a problem hiding this comment.
Rather than repeat these path parameters over and over, I recommend defining them as parameters like SubscriptionIdParameter and ApiVersionParameter. It'll help reduce errors.
Ideally, since most will be shared across all control plane swaggers, you could define a common.json like we did for the data plane, but that's more of a stretch goal.
specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/keys.json
Show resolved
Hide resolved
specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/keys.json
Show resolved
Hide resolved
specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/keys.json
Show resolved
Hide resolved
specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/keys.json
Show resolved
Hide resolved
adarce
reviewed
May 28, 2021
specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/keys.json
Show resolved
Hide resolved
heaths
approved these changes
Jun 1, 2021
JeffreyRichter
approved these changes
Jun 2, 2021
JeffreyRichter
added
Approved-Avocado
Approved-BreakingChange
|
@qinl-li please fix the Lint error. And is the new apiVersion deployed? |
leni-msft
reviewed
Jun 3, 2021
specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/keys.json
Outdated
Show resolved
Hide resolved
This was referenced Jun 4, 2021
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* Import keys.json with rotation policy parameters * Update * Fixed spelling * prettier fix * Remove keyrotationpolicy parameters * Change type name
qinl-li
deleted the
Azure-KeyVault-Import-KeysJson-To-2021-04-01-Preview
branch
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
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 Breaking Change 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.