Skip to content
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

[Key Vault] Add 7.6-preview.2 to TSP #32332

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

[Key Vault] Add 7.6-preview.2 to TSP #32332

wants to merge 12 commits into from

Conversation

mccoyp
Copy link
Member

@mccoyp mccoyp commented Jan 24, 2025

Data Plane API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

This integrates the changes from #31670 into TSP. The relevant API changes are in:

  • Security.KeyVault.Certificates/models.tsp
  • Security.KeyVault.Keys/models.tsp
  • Security.KeyVault.Keys/routes.tsp

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

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

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

Getting help

  • First, please carefully read through this PR description, from top to bottom.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • 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.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

Copy link

openapi-pipeline-app bot commented Jan 24, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ The required check named SDK azure-sdk-for-go has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide. In addition, refer to step 3 in the PR workflow diagram

Copy link

openapi-pipeline-app bot commented Jan 24, 2025

Generated ApiView

Language Package Name ApiView Link
Go sdk/security/keyvault/azcertificates There is no API change compared with the previous version
Go sdk/security/keyvault/azkeys There is no API change compared with the previous version
Go sdk/security/keyvault/azsecrets There is no API change compared with the previous version
Python azure-keyvault-administration https://apiview.dev/Assemblies/Review/7643acce229a47c8a2d146efc30638fb?revisionId=6ba8e2c7f00a49cdad42dd27f725cfe1
Python azure-keyvault-certificates https://apiview.dev/Assemblies/Review/b2fdced96a5343cc972aac842b5f43fc?revisionId=c6a7b2955fee4834bfd13ad7b3bdac0e
Python azure-keyvault-keys https://apiview.dev/Assemblies/Review/9507cb5f29024272a1f19016634b6a25?revisionId=f7e624c0061544fc9adfdb70f2457884
Python azure-keyvault-secrets https://apiview.dev/Assemblies/Review/8103c86200684133980931472e4f8e24?revisionId=058743e80a4a44d8a5d78e2e87a55c06
TypeSpec Security.KeyVault.BackupRestore https://apiview.dev/Assemblies/Review/0529655b61bc404ebd37d2d5192ba45a?revisionId=04c9d6afcfbb41aea280a329025603f5
TypeSpec Security.KeyVault.Certificates https://apiview.dev/Assemblies/Review/0529655b61bc404ebd37d2d5192ba45a?revisionId=04c9d6afcfbb41aea280a329025603f5
TypeSpec Security.KeyVault.Keys https://apiview.dev/Assemblies/Review/0529655b61bc404ebd37d2d5192ba45a?revisionId=04c9d6afcfbb41aea280a329025603f5
TypeSpec Security.KeyVault.RBAC https://apiview.dev/Assemblies/Review/0529655b61bc404ebd37d2d5192ba45a?revisionId=04c9d6afcfbb41aea280a329025603f5
TypeSpec Security.KeyVault.Secrets https://apiview.dev/Assemblies/Review/0529655b61bc404ebd37d2d5192ba45a?revisionId=04c9d6afcfbb41aea280a329025603f5
TypeSpec Security.KeyVault.Settings https://apiview.dev/Assemblies/Review/0529655b61bc404ebd37d2d5192ba45a?revisionId=04c9d6afcfbb41aea280a329025603f5

@azure-sdk
Copy link
Collaborator

azure-sdk commented Jan 24, 2025

API change check

APIView has identified API level changes in this PR and created following API reviews.

Microsoft.KeyVault
KeyVault

@AzureRestAPISpecReview AzureRestAPISpecReview added new-api-version VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required labels Jan 24, 2025
@github-actions github-actions bot added the brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. label Jan 24, 2025
Copy link
Member

@heaths heaths left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIRC, these are the changes I remember reviewing. As long as the breaking change checks pass, this looks good to go.

Curious why all the Admin examples are newly added files, though. They don't seem wrong - just unexpected.

@heaths
Copy link
Member

heaths commented Jan 28, 2025

@mccoyp CredScan failed. Definitely take a look at that. Probably a fluke, though.

@mccoyp
Copy link
Member Author

mccoyp commented Jan 28, 2025

@mccoyp CredScan failed. Definitely take a look at that. Probably a fluke, though.

@heaths Yep, unfortunately the scanner thinks that "value": "A256CBCPAD" is exposing a secret in keys.json. Wes said that a refinement for the check should be coming in soonish

@mccoyp
Copy link
Member Author

mccoyp commented Jan 28, 2025

I learned from the TypeSpec team that specs should only include one preview version (and only include it if it's newer than the latest stable version), hence fbcc781. Swaggers should be left as-is and emitting from TSP won't cause issues since Swaggers for versions not in the spec won't be emitted.

@mccoyp
Copy link
Member Author

mccoyp commented Jan 29, 2025

The Go SDK automation failures (package 'azadmin' doesn't contain any exports) are from known bugs/limitations. Like in #30239, we can bypass these to merge when we hear from Managed HSM about whether a last enum change should be added. cc @karenychen

@mccoyp mccoyp added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Jan 30, 2025
@mccoyp mccoyp added the APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. label Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. data-plane KeyVault new-api-version PublishToCustomers Acknowledgement the changes will be published to Azure customers. TypeSpec Authored with TypeSpec
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

6 participants