Migrate EXPORT to 7.3-preview #12320

herveyw-msft · 2021-01-07T20:56:03Z

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-workflow-bot · 2021-01-07T20:56:05Z

Hi, @herveyw-msft Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

openapi-pipeline-app · 2021-01-07T20:56:07Z

Swagger Validation Report

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

Only 10 items are listed, please refer to log for more details.

Compared Swaggers (Based on Oad v0.8.6)
- original: preview/7.2-preview/keys.json <---> new: preview/7.2-preview/keys.json
- original: preview/7.3-preview/keys.json <---> new: preview/7.3-preview/keys.json

Rule	Message
`❌` 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/keys/{key-name}/{key-version}/export' removed or restructured? Old: Microsoft.KeyVault/preview/7.2-preview/keys.json#L811:5
`❌` 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'KeyReleasePolicy' removed or renamed? New: Microsoft.KeyVault/preview/7.2-preview/keys.json#L977:3 Old: Microsoft.KeyVault/preview/7.2-preview/keys.json#L1035:3
`❌` 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'KeyExportParameters' removed or renamed? New: Microsoft.KeyVault/preview/7.2-preview/keys.json#L977:3 Old: Microsoft.KeyVault/preview/7.2-preview/keys.json#L1035:3
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'exportKey' to 'export'. This will impact generated code. New: Microsoft.KeyVault/preview/7.3-preview/keys.json#L812:7 Old: Microsoft.KeyVault/preview/7.3-preview/keys.json#L812:7
`❌` 1019 - RemovedEnumValue	The new version is removing enum value(s) 'export' from the old version. New: Microsoft.KeyVault/preview/7.2-preview/keys.json#L1376:11 Old: Microsoft.KeyVault/preview/7.2-preview/keys.json#L1460:11
`❌` 1019 - RemovedEnumValue	The new version is removing enum value(s) 'export' from the old version. New: Microsoft.KeyVault/preview/7.2-preview/keys.json#L1639:11 Old: Microsoft.KeyVault/preview/7.2-preview/keys.json#L1746:11
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'exportable' renamed or removed? New: Microsoft.KeyVault/preview/7.2-preview/keys.json#L1138:7 Old: Microsoft.KeyVault/preview/7.2-preview/keys.json#L1196:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'release_policy' renamed or removed? New: Microsoft.KeyVault/preview/7.2-preview/keys.json#L1346:7 Old: Microsoft.KeyVault/preview/7.2-preview/keys.json#L1430:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'release_policy' renamed or removed? New: Microsoft.KeyVault/preview/7.2-preview/keys.json#L1198:7 Old: Microsoft.KeyVault/preview/7.2-preview/keys.json#L1260:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'release_policy' renamed or removed? New: Microsoft.KeyVault/preview/7.2-preview/keys.json#L1427:7 Old: Microsoft.KeyVault/preview/7.2-preview/keys.json#L1516:7

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

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

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

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

openapi-pipeline-app · 2021-01-07T20:56:08Z

Swagger Generation Artifacts

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 612f78a. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️keyvault/v7.1/keyvault [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️keyvault/v7.0/keyvault [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️keyvault/2016-10-01/keyvault [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️keyvault/2015-06-01/keyvault [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```

️✔️preview/keyvault/v7.2-preview/keyvault [View full logs] [Release SDK Changes] Breaking Change Detected

Only show 24 items here, please refer to log for details.

info	[Changelog] - New function `RoleDefinitionsClient.GetResponder(*http.Response) (RoleDefinition, error)`
info	[Changelog] - New function `RoleDefinitionsClient.DeletePreparer(context.Context, string, string, string) (*http.Request, error)`
info	[Changelog] - New function `PossibleRoleScopeValues() []RoleScope`
info	[Changelog] - New function `PossibleRoleDefinitionTypeValues() []RoleDefinitionType`
info	[Changelog] - New function `RoleDefinitionsClient.CreateOrUpdatePreparer(context.Context, string, string, string, RoleDefinitionCreateParameters) (*http.Request, error)`
info	[Changelog] - New function `PossibleDataActionValues() []DataAction`
info	[Changelog] - New function `RoleDefinitionsClient.CreateOrUpdateResponder(*http.Response) (RoleDefinition, error)`
info	[Changelog] - New function `RoleDefinitionsClient.Delete(context.Context, string, string, string) (RoleDefinition, error)`
info	[Changelog] - New function `RoleDefinitionsClient.CreateOrUpdateSender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `RoleDefinitionsClient.CreateOrUpdate(context.Context, string, string, string, RoleDefinitionCreateParameters) (RoleDefinition, error)`
info	[Changelog] - New function `RoleDefinitionsClient.GetSender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `RoleDefinitionsClient.DeleteSender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `RoleDefinitionsClient.DeleteResponder(*http.Response) (RoleDefinition, error)`
info	[Changelog] - New function `PossibleRoleTypeValues() []RoleType`
info	[Changelog] - New function `RoleDefinitionsClient.Get(context.Context, string, string, string) (RoleDefinition, error)`
info	[Changelog] - New function `RoleDefinitionsClient.GetPreparer(context.Context, string, string, string) (*http.Request, error)`
info	[Changelog] - New struct `RoleDefinitionCreateParameters`
info	[Changelog] - New anonymous field `autorest.Response` in struct `RoleDefinition`
info	[Changelog] - New field `Iv` in struct `KeyOperationResult`
info	[Changelog] - New field `AuthenticationTag` in struct `KeyOperationResult`
info	[Changelog] - New field `AdditionalAuthenticatedData` in struct `KeyOperationResult`
info	[Changelog]
info	[Changelog] Total 20 breaking change(s), 54 additive change(s).
info	[Changelog]

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

 Please click here to preview with your @microsoft account.

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

openapi-workflow-bot · 2021-01-07T21:19:43Z

Hi @herveyw-msft, 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."

openapi-workflow-bot · 2021-01-07T21:20:46Z

Hi @herveyw-msft, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
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.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

daviddesberg · 2021-01-07T22:00:16Z

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

@@ -1616,7 +1623,7 @@
          "description": "The target environment assertion."
        }
      },
-      "description": "The export key parameters.",
+      "description": "The release key parameters.",


The key release parameters rather than release key parameters (nit)

I think its equivalent ;-)

...n/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/examples/ExportKey-example.json

heaths · 2021-01-07T22:08:21Z

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

+        ],
+        "operationId": "releaseKey",
+        "summary": "Releases a key.",
+        "description": "The release key operation is applicable to all key types. The target key must be marked exportable. This operation requires the keys/release permission.",


Should this differentiate between export and release? To be honest, I'm not entirely sure on the difference either and I'm sure customers will raise the question later.

Export is the reverse of Import. Release is a specialized Export used with Trusted Execution Environments. They are separated to enable more granular access control as Export must be closely controlled.

That's what I thought :) but I would put something to that effect in the description. I anticipate customers will have this same question, and these descriptions should also end up being the default doc comments for the SDK code.

heaths · 2021-01-07T22:09:49Z

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

-        "version": {
-          "description": "key release policy version",
+        "contentType": {
+          "description": "Content type and version of key release policy",


Should reword this to fit the value, like "Content type, policy schema version, and optional content encoding of the key release policy"

This was just copied over from the original 7.2-preview file.

Understood, but we've collectively made doc improvements in the past. ;) Consider this a nit, though.

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

herveyw-msft · 2021-01-07T23:00:11Z

Breaking Changes: the PR modifies an existing Preview protocol version to move capabilities that will not be finalized until a later version. As a result, the check identify these moves as breaking changes but the original protocol version was never final.

tjprescott · 2021-01-08T22:46:30Z

@herveyw-msft we can certainly override the breaking change flag from the CI based on that circumstance, but it looks like there are other failing CI checks that need to be addressed first.

tjprescott · 2021-01-08T23:01:18Z

/azp run

azure-pipelines · 2021-01-08T23:01:33Z

Azure Pipelines successfully started running 2 pipeline(s).

tjprescott · 2021-01-14T17:56:50Z

Please address the Required CI failures.

heaths

I realized that you also need to remove the export key operation.

/cc @lusitanian

openapi-workflow-bot · 2021-01-25T22:20:01Z

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.

herveyw-msft · 2021-01-25T23:25:45Z

I realized that you also need to remove the export key operation.

/cc @lusitanian

Fixed in the changes from a rebase and model validation updates.

* Migrate EXPORT to 7.3-preview * Correct syntax issues in examples * Fix ExportKey example * Remove exportabe from 7.2, fix -HSM text, fix Export example * Fix prettier issues * Add files for 7.3-preview to readme.md * Fix model validation issues * Fix JsonWebKeyOperation double definition mismatch

herveyw-msft requested review from heaths, jlichwa and RandalliLama as code owners January 7, 2021 20:56

openapi-assignment-bot bot assigned tjprescott Jan 7, 2021

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

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

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

daviddesberg reviewed Jan 7, 2021

View reviewed changes

heaths approved these changes Jan 7, 2021

View reviewed changes

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

heaths approved these changes Jan 9, 2021

View reviewed changes

heaths reviewed Jan 21, 2021

View reviewed changes

heaths mentioned this pull request Jan 21, 2021

Remove secure key release Azure/azure-sdk-for-net#17901

Closed

herveyw-msft added 4 commits January 25, 2021 13:11

Migrate EXPORT to 7.3-preview

794ba3c

Correct syntax issues in examples

0a40ab7

Fix ExportKey example

2f89e99

Remove exportabe from 7.2, fix -HSM text, fix Export example

6aeee7d

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

Fix prettier issues

be40220

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

Add files for 7.3-preview to readme.md

fab49ce

herveyw-msft requested a review from lirenhe as a code owner January 25, 2021 21:43

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

Fix model validation issues

e93a2c7

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

openapi-pipeline-app bot removed the CI-BreakingChange-Go label Jan 25, 2021

Fix JsonWebKeyOperation double definition mismatch

8aaea08

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

lmazuel merged commit 612f78a into Azure:master Jan 26, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate EXPORT to 7.3-preview #12320

Migrate EXPORT to 7.3-preview #12320

herveyw-msft commented Jan 7, 2021

openapi-workflow-bot bot commented Jan 7, 2021

openapi-pipeline-app bot commented Jan 7, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jan 7, 2021 •

edited

Loading

openapi-workflow-bot bot commented Jan 7, 2021

openapi-workflow-bot bot commented Jan 7, 2021

daviddesberg Jan 7, 2021 •

edited

Loading

herveyw-msft Jan 7, 2021

heaths Jan 7, 2021

herveyw-msft Jan 7, 2021

heaths Jan 7, 2021

heaths Jan 7, 2021

herveyw-msft Jan 7, 2021

heaths Jan 7, 2021

herveyw-msft commented Jan 7, 2021

tjprescott commented Jan 8, 2021

tjprescott commented Jan 8, 2021

azure-pipelines bot commented Jan 8, 2021

tjprescott commented Jan 14, 2021

heaths left a comment •

edited

Loading

openapi-workflow-bot bot commented Jan 25, 2021

herveyw-msft commented Jan 25, 2021

Migrate EXPORT to 7.3-preview #12320

Migrate EXPORT to 7.3-preview #12320

Conversation

herveyw-msft commented Jan 7, 2021

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jan 7, 2021

openapi-pipeline-app bot commented Jan 7, 2021 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jan 7, 2021 • edited Loading

Swagger Generation Artifacts

openapi-workflow-bot bot commented Jan 7, 2021

openapi-workflow-bot bot commented Jan 7, 2021

daviddesberg Jan 7, 2021 • edited Loading

Choose a reason for hiding this comment

herveyw-msft Jan 7, 2021

Choose a reason for hiding this comment

heaths Jan 7, 2021

Choose a reason for hiding this comment

herveyw-msft Jan 7, 2021

Choose a reason for hiding this comment

heaths Jan 7, 2021

Choose a reason for hiding this comment

heaths Jan 7, 2021

Choose a reason for hiding this comment

herveyw-msft Jan 7, 2021

Choose a reason for hiding this comment

heaths Jan 7, 2021

Choose a reason for hiding this comment

herveyw-msft commented Jan 7, 2021

tjprescott commented Jan 8, 2021

tjprescott commented Jan 8, 2021

azure-pipelines bot commented Jan 8, 2021

tjprescott commented Jan 14, 2021

heaths left a comment • edited Loading

Choose a reason for hiding this comment

openapi-workflow-bot bot commented Jan 25, 2021

herveyw-msft commented Jan 25, 2021

openapi-pipeline-app bot commented Jan 7, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jan 7, 2021 •

edited

Loading

daviddesberg Jan 7, 2021 •

edited

Loading

heaths left a comment •

edited

Loading