Key Vault keys API: Add OKP key type and EdDSA digital signature by docschmidt · Pull Request #15943 · Azure/azure-rest-api-specs

docschmidt · 2021-09-07T22:11:54Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for 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 are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the 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 refresh required 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

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

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 label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] 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.
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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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-09-07T22:11:56Z

Hi, @docschmidt 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-workflow-bot · 2021-09-07T22:11:57Z

[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.

openapi-pipeline-app · 2021-09-07T22:11:58Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

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

️⚠️LintDiff: 0 Warnings warning [Detail]

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

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/preview/7.3-preview/rbac.json#L476
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/preview/7.3-preview/rbac.json#L518
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/preview/7.3-preview/rbac.json#L530
⚠️ 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 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

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

️️✔️[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 · 2021-09-07T22:11:59Z

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 - v57.2.0
️✔️azure-sdk-for-go - keyvault/v7.1/keyvault - v57.2.0
️✔️azure-sdk-for-go - keyvault/v7.0/keyvault - v57.2.0
️✔️azure-sdk-for-go - keyvault/2016-10-01/keyvault - v57.2.0
️✔️azure-sdk-for-go - keyvault/2015-06-01/keyvault - v57.2.0
❌azure-sdk-for-go - preview/keyvault/v7.2-preview/keyvault - v57.2.0

+	Package was removed

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

️✔️Succeeded [Logs] Generate from f4db16ed9f7133057e52034fe0bb75e104dc2d67. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️keyvault/v7.2/keyvault [View full logs] [Preview SDK Changes]
```
info	[Changelog] This is a new package
```
️✔️keyvault/v7.1/keyvault [View full logs]
```
info	[Changelog] No exported changes
```
️✔️keyvault/v7.0/keyvault [View full logs]
```
info	[Changelog] No exported changes
```
️✔️keyvault/2016-10-01/keyvault [View full logs]
```
info	[Changelog] No exported changes
```
️✔️keyvault/2015-06-01/keyvault [View full logs]
```
info	[Changelog] No exported changes
```
️✔️preview/keyvault/v7.2-preview/keyvault [View full logs] Breaking Change Detected
```
info	[Changelog] This package was removed
```

️❌ azure-sdk-for-net-track2 failed [Detail]

❌Failed [Logs] Generate from f4db16ed9f7133057e52034fe0bb75e104dc2d67. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
command	pwsh ./eng/scripts/Automation-Sdk-Generate.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
warn	No file changes detected after generation
error	Fatal error: packageFolderFromFileSearch not configured and could not be found in legacy config
packageFolderFromFileSearch not configured and could not be found in legacy config
Error: packageFolderFromFileSearch not configured and could not be found in legacy config
    at workflowDetectChangedPackages (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:422:23)
    at workflowHandleReadmeMd (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:168:11)
    at async Object.exports.workflowMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:83:9)
    at async Object.exports.sdkAutoMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:152:13)
    at async /home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18

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

tjprescott · 2021-09-07T22:49:15Z

@docschmidt please answer the following from the checklist:

When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.

docschmidt · 2021-09-07T23:18:08Z

@docschmidt please answer the following from the checklist:

When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.

When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.

@tjprescott, the feature is already live in public regions. In regards to publishing the Swagger, I'll get back to you.

heaths · 2021-09-07T23:33:47Z

+            "OKP",
+            "OKP-HSM"


This is news to the Azure SDK team for 7.3-preview. Should this be in 7.4-preview?

/cc @jlichwa @maorleger

If it is intended for 7.3-preview, is it supported in Key Vault and or Managed HSM? Do RPs in the public clouds already support it? If not, when? We need time to add support, write up tests, and record new sessions.

Yes I was not aware of this either, and I agree that it is likely 7.4....

Discussed this offline with Jack. I will cancel this PR, wait for 7.4-preview availability, and resubmit.

Regarding 7.4-preview, what is the ETA for the branch/folder?

It's already created but needs a PR to fully prep it. @jhendrixMSFT or @lmazuel can you merge PR #15900 ?

Add OKP key type and EdDSA digital signature

8eaf332

docschmidt requested review from RandalliLama, heaths and jlichwa as code owners September 7, 2021 22:11

openapi-assignment-bot Bot assigned tjprescott Sep 7, 2021

openapi-pipeline-app Bot added the CI-BreakingChange-Go label Sep 7, 2021

vasanthrajams approved these changes Sep 7, 2021

View reviewed changes

tjprescott approved these changes Sep 7, 2021

View reviewed changes

vasanthrajams requested review from herveyw-msft and vickm September 7, 2021 23:08

heaths requested changes Sep 7, 2021

View reviewed changes

Merge branch 'Azure:main' into feature/mhsm-eddsa

d29fcc0

docschmidt closed this Sep 9, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Key Vault keys API: Add OKP key type and EdDSA digital signature#15943

Key Vault keys API: Add OKP key type and EdDSA digital signature#15943
docschmidt wants to merge 2 commits intoAzure:mainfrom
docschmidt:feature/mhsm-eddsa

docschmidt commented Sep 7, 2021

Uh oh!

openapi-workflow-bot Bot commented Sep 7, 2021

Uh oh!

openapi-workflow-bot Bot commented Sep 7, 2021

Uh oh!

openapi-pipeline-app Bot commented Sep 7, 2021 •

edited

Loading

Uh oh!

openapi-pipeline-app Bot commented Sep 7, 2021 •

edited

Loading

Breaking Changes Tracking

Uh oh!

tjprescott commented Sep 7, 2021

Uh oh!

docschmidt commented Sep 7, 2021

Uh oh!

heaths Sep 7, 2021

Uh oh!

heaths Sep 7, 2021

Uh oh!

jlichwa Sep 8, 2021

Uh oh!

docschmidt Sep 8, 2021

Uh oh!

docschmidt Sep 8, 2021

Uh oh!

heaths Sep 8, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

docschmidt commented Sep 7, 2021

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot Bot commented Sep 7, 2021

Uh oh!

openapi-workflow-bot Bot commented Sep 7, 2021

Uh oh!

openapi-pipeline-app Bot commented Sep 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app Bot commented Sep 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

tjprescott commented Sep 7, 2021

Uh oh!

docschmidt commented Sep 7, 2021

Uh oh!

heaths Sep 7, 2021

Choose a reason for hiding this comment

Uh oh!

heaths Sep 7, 2021

Choose a reason for hiding this comment

Uh oh!

jlichwa Sep 8, 2021

Choose a reason for hiding this comment

Uh oh!

docschmidt Sep 8, 2021

Choose a reason for hiding this comment

Uh oh!

docschmidt Sep 8, 2021

Choose a reason for hiding this comment

Uh oh!

heaths Sep 8, 2021

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

openapi-pipeline-app Bot commented Sep 7, 2021 •

edited

Loading

openapi-pipeline-app Bot commented Sep 7, 2021 •

edited

Loading