Key rotation swagger change #11965

qinl-li · 2020-12-05T00:40:02Z

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.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of “no breaking changes
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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.
- Adding new API(s)
- Adding a new API version
- Adding a new service
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.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable version with Breaking Change Validation errors
Updating API(s) in preview over 1 year

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.

openapi-pipeline-app · 2020-12-05T00:40:06Z

Swagger Validation Report

️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.8.9)
- current:preview/7.3-preview/keys.json compared with base:preview/7.3-preview/keys.json

Rule	Message
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.KeyVault/preview/7.3-preview/keys.json#L82:5
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.KeyVault/preview/7.3-preview/keys.json#L1134:5

️⚠️LintDiff: 0 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- keyvault/data-plane/readme.md tag:package-preview-7.3-preview
Linted configuring files (Based on target branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- keyvault/data-plane/readme.md tag:package-preview-7.3-preview

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` R2005 - LongRunningResponseStatusCode	A 'PUT' operation 'FullRestoreOperation' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201. Location: Microsoft.KeyVault/preview/7.3-preview/backuprestore.json#L131
`❌` R2005 - LongRunningResponseStatusCode	A 'PUT' operation 'SelectiveKeyRestoreOperation' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201. Location: Microsoft.KeyVault/preview/7.3-preview/backuprestore.json#L226
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/preview/7.3-preview/rbac.json#L477
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/preview/7.3-preview/rbac.json#L519
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/preview/7.3-preview/rbac.json#L531
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'CreateCertificate' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.KeyVault/preview/7.3-preview/certificates.json#L458

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: expirationTime Url: Microsoft.KeyVault/preview/7.3-preview/keys.json#L2268

️️✔️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

keyvault/data-plane/readme.md#package-preview-7.3-preview

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"keyvault/data-plane/readme.md",
"tag":"package-preview-7.3-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"keyvault/data-plane/readme.md",
"tag":"package-preview-7.3-preview",
"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/data-plane/readme.md",
"tag":"package-preview-7.3-preview",
"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).

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2020-12-05T00:40:06Z

Swagger Generation Artifacts

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️❌[Staging] SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

️✔️azure-sdk-for-go - keyvault/v7.2/keyvault - v55.0.0
️✔️azure-sdk-for-go - keyvault/v7.1/keyvault - v55.0.0
️✔️azure-sdk-for-go - keyvault/v7.0/keyvault - v55.0.0
️✔️azure-sdk-for-go - keyvault/2016-10-01/keyvault - v55.0.0
️✔️azure-sdk-for-go - keyvault/2015-06-01/keyvault - v55.0.0
❌azure-sdk-for-go - preview/keyvault/v7.2-preview/keyvault - v55.0.0

+	Package was removed

️❌ azure-sdk-for-go failed [Detail]

❌Failed [Logs]Release - Generate from f4a4bad. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: sh ./initScript.sh
warn	File azure-sdk-for-go_tmp/initOutput.json not found to read
command	go run ./tools/generator/main.go automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: go run ./tools/generator/main.go automation
warn	Skip package processing as generation is failed

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2020-12-05T00:42:29Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

...eyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/examples/GetKeyPolicy-example.json

specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json

heaths · 2020-12-05T01:31:48Z

specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json

+      },
+      "description": "The action that will be executed."
+    },
+    "KeyPolicyAttributes": {


Are any of these values required?

….3-preview/keys.json Co-authored-by: Heath Stewart <[email protected]>

ghost · 2021-01-03T16:01:26Z

Hi, @qinl-li. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

openapi-workflow-bot · 2021-01-07T02:12:33Z

Hi @qinl-li, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

heaths · 2021-01-07T22:02:54Z

specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json

@@ -2149,23 +2159,31 @@
      "properties": {
        "rotationEnabled": {
          "type": "boolean",
+          "required": false,


Nit: the default for required is false so this isn't necessary, but doesn't hurt.

…into Microsoft.KeyVault-DP-7.3-preview-KeyAutoRotation

...a-plane/Microsoft.KeyVault/preview/7.3-preview/examples/UpdateKeyRotationPolicy-example.json

specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json

…into Microsoft.KeyVault-DP-7.3-preview-KeyAutoRotation

heaths · 2021-03-06T01:18:39Z

@qinl-li can you please resolve comments as you make changes so we can better spot changes?

specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json

ghost · 2021-03-28T16:00:47Z

Hi, @qinl-li. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

ghost · 2021-04-12T05:00:24Z

Hi, @qinl-li. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

qinl-li · 2021-05-28T16:23:27Z

/azp run

azure-pipelines · 2021-05-28T16:23:38Z

Azure Pipelines successfully started running 1 pipeline(s).

specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json

heaths · 2021-06-01T17:34:01Z

@lmazuel can you merge this? I haven't permissions when there are validation errors, which is expected for KV for now.

* Key rotation swagger change * Run PrettierCheck * fixed spellcheck error * Update specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json Co-authored-by: Heath Stewart <[email protected]> * Update based on comments * fix prettier failure * Update Api names * Add custom words * Update to key rotation policy * Remove key rotation policy from response * Remove required * fix validation error * remove parameter force * Rotate api should be post * udpate description * Update UpdateKeyRotationPolicy-example * Update names * Microsoft.KeyVault-DP-7.3-preview-KeyAutoRotation * Update Co-authored-by: Jack Lichwa <[email protected]> Co-authored-by: Heath Stewart <[email protected]>

Key rotation swagger change

f59c01b

qinl-li requested review from heaths, jlichwa and RandalliLama as code owners December 5, 2020 00:40

openapi-assignment-bot bot assigned lmazuel Dec 5, 2020

openapi-pipeline-app bot added the NewApiVersionRequired label Dec 5, 2020

qinl-li added 2 commits December 4, 2020 16:51

Run PrettierCheck

de30be9

fixed spellcheck error

66f75ea

heaths approved these changes Dec 5, 2020

View reviewed changes

Update specification/keyvault/data-plane/Microsoft.KeyVault/preview/7…

4ffab69

….3-preview/keys.json Co-authored-by: Heath Stewart <[email protected]>

lmazuel assigned heaths and unassigned lmazuel Dec 18, 2020

ghost added the no-recent-activity label Jan 3, 2021

Update based on comments

b7083d2

ghost removed the no-recent-activity label Jan 7, 2021

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Jan 7, 2021

openapi-pipeline-app bot removed the NewApiVersionRequired label Jan 7, 2021

fix prettier failure

ea0a273

openapi-pipeline-app bot added the CI-BreakingChange-Go label Jan 7, 2021

heaths approved these changes Jan 7, 2021

View reviewed changes

qinl-li added 2 commits January 15, 2021 15:33

Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs …

6c46952

…into Microsoft.KeyVault-DP-7.3-preview-KeyAutoRotation

Update Api names

c51a6d7

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Jan 19, 2021

Add custom words

ac7f8a2

msfcolombo reviewed Jan 31, 2021

View reviewed changes

...a-plane/Microsoft.KeyVault/preview/7.3-preview/examples/UpdateKeyRotationPolicy-example.json Show resolved Hide resolved

Update UpdateKeyRotationPolicy-example

fed0916

heaths requested changes Feb 3, 2021

View reviewed changes

msfcolombo reviewed Feb 5, 2021

View reviewed changes

specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json Outdated Show resolved Hide resolved

adarce reviewed Feb 22, 2021

View reviewed changes

specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json Show resolved Hide resolved

qinl-li added 2 commits March 5, 2021 10:19

Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs …

e71ecbc

…into Microsoft.KeyVault-DP-7.3-preview-KeyAutoRotation

Update names

539c966

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Mar 6, 2021

heaths approved these changes Mar 8, 2021

View reviewed changes

specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json Outdated Show resolved Hide resolved

ghost added the no-recent-activity label Mar 28, 2021

ghost closed this Apr 12, 2021

qinl-li reopened this May 28, 2021

ghost removed the no-recent-activity label May 28, 2021

qinl-li added 2 commits May 27, 2021 18:57

Microsoft.KeyVault-DP-7.3-preview-KeyAutoRotation

2b03001

resolved conflicts

7df2a9d

heaths approved these changes May 28, 2021

View reviewed changes

adarce reviewed May 28, 2021

View reviewed changes

Update

ac4d106

lmazuel merged commit f4a4bad into master Jun 4, 2021

heaths mentioned this pull request Jun 16, 2021

Initial 2021-05-01-preview version #14855

Merged

qinl-li deleted the Microsoft.KeyVault-DP-7.3-preview-KeyAutoRotation branch January 28, 2022 22:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Key rotation swagger change #11965

Key rotation swagger change #11965

qinl-li commented Dec 5, 2020

openapi-pipeline-app bot commented Dec 5, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 5, 2020 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented Dec 5, 2020

heaths Dec 5, 2020

ghost commented Jan 3, 2021

openapi-workflow-bot bot commented Jan 7, 2021

heaths Jan 7, 2021

heaths commented Mar 6, 2021

ghost commented Mar 28, 2021

ghost commented Apr 12, 2021

qinl-li commented May 28, 2021

azure-pipelines bot commented May 28, 2021

heaths commented Jun 1, 2021

Key rotation swagger change #11965

Key rotation swagger change #11965

Conversation

qinl-li commented Dec 5, 2020

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-pipeline-app bot commented Dec 5, 2020 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Dec 5, 2020 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented Dec 5, 2020

heaths Dec 5, 2020

Choose a reason for hiding this comment

ghost commented Jan 3, 2021

openapi-workflow-bot bot commented Jan 7, 2021

heaths Jan 7, 2021

Choose a reason for hiding this comment

heaths commented Mar 6, 2021

ghost commented Mar 28, 2021

ghost commented Apr 12, 2021

qinl-li commented May 28, 2021

azure-pipelines bot commented May 28, 2021

heaths commented Jun 1, 2021

openapi-pipeline-app bot commented Dec 5, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 5, 2020 •

edited

Loading