Azure
Release keyvault microsoft.key vault 7.5
Data Plane API - Pull Request
GA 7.5-preview.1, which included only a couple model changes.
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
- Link to API Spec engagement record issue:
Is this review for (select one):
- [ ] a private preview
- [ ] a public preview
- [x] GA release
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
- Design Document:
- Previous API Spec Doc:
- Updated paths:
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.
Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the Swagger-Suppression-Process to get approval.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
- 💬 Teams Channel
Click here for links to tools, specs, guidelines & other good stuff
Tooling
- Open API validation tools were run on this PR. Go here to see how to fix errors
- Spectral Linting
- Open API Hub
Guidelines & Specifications
Helpful Links
Checks stuck in `queued` state?
If the PR CI checks appear to be stuck in `queued` state, please add a comment with contents `/azp run`. This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes.
Next Steps to Merge
✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 2 Errors, 11 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| backuprestore.json | 7.5(1bc8a6c) | 7.4(main) |
| backuprestore.json | 7.5(1bc8a6c) | 7.4-preview.1(main) |
| certificates.json | 7.5(1bc8a6c) | 7.4(main) |
| certificates.json | 7.5(1bc8a6c) | 7.4-preview.1(main) |
| common.json | 7.5(1bc8a6c) | 7.4(main) |
| common.json | 7.5(1bc8a6c) | 7.4-preview.1(main) |
| keys.json | 7.5(1bc8a6c) | 7.4(main) |
| keys.json | 7.5(1bc8a6c) | 7.4-preview.1(main) |
| rbac.json | 7.5(1bc8a6c) | 7.4(main) |
| rbac.json | 7.5(1bc8a6c) | 7.4-preview.1(main) |
| secrets.json | 7.5(1bc8a6c) | 7.4(main) |
| secrets.json | 7.5(1bc8a6c) | 7.4-preview.1(main) |
| securitydomain.json | 7.5(1bc8a6c) | 7.4(main) |
| securitydomain.json | 7.5(1bc8a6c) | 7.4-preview.1(main) |
| settings.json | 7.5(1bc8a6c) | 7.4(main) |
| settings.json | 7.5(1bc8a6c) | 7.4-preview.1(main) |
| storage.json | 7.5(1bc8a6c) | 7.4(main) |
| storage.json | 7.5(1bc8a6c) | 7.4-preview.1(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
The 'required' status changed from the old version('True') to the new version('False'). New: Microsoft.KeyVault/stable/7.5/backuprestore.json#L347:7 Old: Microsoft.KeyVault/stable/7.4/backuprestore.json#L347:7 |
|
The new version has a different x-ms-enum 'name' than the previous one. New: Microsoft.KeyVault/stable/7.5/keys.json#L2200:9 Old: Microsoft.KeyVault/stable/7.4/keys.json#L2195:9 |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️🔄LintDiff inProgress [Detail]
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Missing required property: api-version Url: Microsoft.KeyVault/stable/7.5/rbac.json#L75:28 ExampleUrl: stable/7.5/examples/DeleteRoleDefinition-example.json#L6:20 |
|
Missing required property: api-version Url: Microsoft.KeyVault/stable/7.5/rbac.json#L75:28 ExampleUrl: stable/7.5/examples/DeleteRoleDefinition-example.json#L6:20 |
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]
Breaking Changes Tracking
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Swagger | Microsoft.KeyVault | https://apiview.dev/Assemblies/Review/829182676c774ce193d9656b4168b090?revisionId=c535abdd372044989ca986d90fb493a6 |
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi @jlichwa! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
@JeffreyRichter @mikekistler the two breaking changes were previously approved:
- The unfortunate discrepancy between "rotate" and "Rotate". We tried one way then had to revert because it broke 3P.
- A previously required property was made optional because it used to only work with SAS but now also supports MSI, so a SAS URL is no longer required.
As for the warnings about being different from the last preview...7.4-preview.1 was not the last preview. 7.5-preview.1 was, of which this is a straight-up re-version. 7.4 did drop support for Ed25519 and OKP so not even sure why that's compared.
The OBJECT_MISSING_REQUIRED_PROPERTY is a known issue and we've approved before. It's a bug where a scope of "/" somehow "hides" subsequent properties, but you can't put it last or validation complains the order is wrong (as though that matters, which it doesn't). Marking ModelValidation approved.