-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Migrate EXPORT to 7.3-preview #12320
Conversation
Hi, @herveyw-msft 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
Only 10 items are listed, please refer to log for more details.
|
Swagger Generation Artifacts
|
Hi @herveyw-msft, Your PR has some issues. Please fix the CI sequentially by following the order of
|
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. |
@@ -1616,7 +1623,7 @@ | |||
"description": "The target environment assertion." | |||
} | |||
}, | |||
"description": "The export key parameters.", | |||
"description": "The release key parameters.", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The key release parameters rather than release key parameters (nit)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think its equivalent ;-)
...n/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/examples/ExportKey-example.json
Outdated
Show resolved
Hide resolved
], | ||
"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.", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
"version": { | ||
"description": "key release policy version", | ||
"contentType": { | ||
"description": "Content type and version of key release policy", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should reword this to fit the value, like "Content type, policy schema version, and optional content encoding of the key release policy"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was just copied over from the original 7.2-preview file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
Show resolved
Hide resolved
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. |
@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. |
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
Please address the Required CI failures. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I realized that you also need to remove the export
key operation.
/cc @lusitanian
NewApiVersionRequired reason: |
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
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 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.