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] docs.microsoft.com -> learn.microsoft.com #32769

Merged
merged 1 commit into from
Feb 25, 2025

Conversation

mccoyp
Copy link
Member

@mccoyp mccoyp commented Feb 22, 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.

There only seems to be one link to "docs.microsoft.com" among KV's specs; this updates that URL to point to the new "learn.microsoft.com" domain.

This only updates the TSP, and by extension only the Swaggers emitted by the spec. I can manually update past API version Swaggers if necessary.

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.

@mccoyp mccoyp added KeyVault Client This issue points to a problem in the data-plane of the library. TypeSpec Authored with TypeSpec PublishToCustomers Acknowledgement the changes will be published to Azure customers. labels Feb 22, 2025
@mccoyp mccoyp requested a review from sandeep-sen February 22, 2025 00:14
Copy link

openapi-pipeline-app bot commented Feb 22, 2025

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Copy link

openapi-pipeline-app bot commented Feb 22, 2025

Generated ApiView

Language Package Name ApiView Link
Go sdk/security/keyvault/azkeys There is no API change compared with the previous version
Java azure-security-keyvault-keys There is no API change compared with the previous version
Python azure-keyvault-keys https://apiview.dev/Assemblies/Review/9507cb5f29024272a1f19016634b6a25?revisionId=70a9f56350cf407391a6c14cd5f8b866

@azure-sdk
Copy link
Collaborator

azure-sdk commented Feb 22, 2025

API change check

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

Microsoft.KeyVault
KeyVault

@heaths heaths added the Versioning-Approved-Benign https://github.com/Azure/azure-sdk-tools/issues/6374 label Feb 22, 2025
@mccoyp mccoyp merged commit 3b51239 into main Feb 25, 2025
32 of 34 checks passed
@mccoyp mccoyp deleted the mccoyp/docs-link-fix branch February 25, 2025 23:17
naveedaz pushed a commit that referenced this pull request Feb 26, 2025
* Bump @azure-tools/typespec-client-generator-core (#32797)

Bumps the typespec group with 1 update in the / directory: [@azure-tools/typespec-client-generator-core](https://github.com/Azure/typespec-azure).


Updates `@azure-tools/typespec-client-generator-core` from 0.51.2 to 0.51.3
- [Release notes](https://github.com/Azure/typespec-azure/releases)
- [Commits](https://github.com/Azure/typespec-azure/compare/@azure-tools/[email protected]...@azure-tools/[email protected])

---
updated-dependencies:
- dependency-name: "@azure-tools/typespec-client-generator-core"
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: typespec
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Sync eng/common directory with azure-sdk-tools for PR 9902 (#32794)

* populate triggeringPaths of each artifactdetails with the owning ci.yml
* handle service-directory changes in Get-PrPkgProperties

---------

Co-authored-by: Scott Beddall <[email protected]>

* [keyvault] Update readme.python.md (#32530)

* update oracle linked service (#32750)

Co-authored-by: Jingshu918 <[email protected]>

* Add Go Data Plane Rules of tspconfig.yaml for TSV (#32779)

* manually add

* add go dp rules

* update

---------

Co-authored-by: albertxavier100 <[email protected]>

* Update Swagger for New PolicyDefinitions and PolicyTokens API (#32306)

* Copy files from stable/2025-01-01

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.

* Update version to stable/2025-03-01

Updated the API version from stable/2025-01-01 to stable/2025-03-01.

* Added tag for 2025-03-01 in readme file

* Update readme.md

* Add external evaluation enforcement settings contract

* Add policy token API contract

* Swagger PrettierCheck

* Swagger PrettierCheck

* Fix JsonSerializationException

* Update contract

* Swagger LintDiff

* Increment to v6

* Revert "Increment to v6"

This reverts commit 64631c5.

* Update error response

* Update duration

* Update sdk-suppressions.yaml

---------

Co-authored-by: Celina Zhao <[email protected]>
Co-authored-by: kazrael2119 <[email protected]>

* [Key Vault] docs.microsoft.com -> learn.microsoft.com (#32769)

* Add Support for Changed Spec Identification in spec-gen-sdk-runner tool (#32763)

* Increase timeout for generation job

* Added git op to the wrapper tool

* cleaned all files before generation

* updated specGenCommand for multiple generation

* Used file system access for file search

* Combined tsp and readme for same service

* Update readme.python.md (#32838)

* Update tspconfig.yaml (#32839)

* migration accessment, config java sdk (#32840)

* Update tspconfig.yaml (#32823)

update name of sdk packaging

* Update MixedReality API with deprecation message (#32386)

* Update MixedReality API

* Copy existing API versino spec files

* Update new API

* Update README with new API version

* Add deprecation message for old API versions

---------

Co-authored-by: Bianca Tazlauanu <[email protected]>

* Add `ListConnectionsInGroup` Api (#31398)

* Copy files from stable/2024-01-01

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.

* Update version to stable/2024-12-01

Updated the API version from stable/2024-01-01 to stable/2024-12-01.

* Added tag for 2024-12-01 in readme file

* Update API spec and examples to 2024-12-01

* fix pagination according to https://github.com/Azure/azure-api-style-guide/blob/main/openapi-style-guide.md#support-for-pagination

* fix(azurearcdata): remove arm-id from sqlServerDatabases (#32825)

* fix(azurearcdata): remove arm-id from sqlServerDatabases

* SRP 2024-01-01 API Version Swagger - PV2 date-time properties fix (#32835)

* Code needs to handle more than one template library (#32853)

Co-authored-by: James Suplizio <[email protected]>

* Bump @autorest/openapi-to-typespec (#32834)

Bumps the openapi-to-typespec group with 1 update in the / directory: [@autorest/openapi-to-typespec](https://github.com/Azure/autorest).


Updates `@autorest/openapi-to-typespec` from 0.10.10 to 0.10.11
- [Release notes](https://github.com/Azure/autorest/releases)
- [Commits](https://github.com/Azure/autorest/commits)

---
updated-dependencies:
- dependency-name: "@autorest/openapi-to-typespec"
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: openapi-to-typespec
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Dev/mibreset/ccm exports fabric3 (#32444)

* Copy files from stable/2024-08-01

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.

* Update version to preview/2024-10-01-preview

Updated the API version from stable/2024-08-01 to preview/2024-10-01-preview.

* Added tag for 2024-10-01-preview in readme file

* ran prettier on entire directory

* made the changes for the fabric version

* fixed spelling issue in pricesheet.json

* adding 'destination type' as required since Destination is required and needs a required field

* Fixed messed up date/time format

* Fixed readme file, was missing the list of input files.

* Removed required annotation from exportDeliveryDestination.

* Include SystemAssigned,UserAssigned (#32826)

* [EngSys] npm update (#32857)

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Scott Beddall <[email protected]>
Co-authored-by: Yuchao Yan <[email protected]>
Co-authored-by: Yao Kou <[email protected]>
Co-authored-by: Jingshu918 <[email protected]>
Co-authored-by: Wanpeng Li <[email protected]>
Co-authored-by: albertxavier100 <[email protected]>
Co-authored-by: ccz77 <[email protected]>
Co-authored-by: Celina Zhao <[email protected]>
Co-authored-by: kazrael2119 <[email protected]>
Co-authored-by: McCoy Patiño <[email protected]>
Co-authored-by: Ray Chen <[email protected]>
Co-authored-by: ChenxiJiang333 <[email protected]>
Co-authored-by: Weidong Xu <[email protected]>
Co-authored-by: Aditya <[email protected]>
Co-authored-by: Bianca Tazlauanu <[email protected]>
Co-authored-by: Bianca Tazlauanu <[email protected]>
Co-authored-by: yzt <[email protected]>
Co-authored-by: Sean Wells <[email protected]>
Co-authored-by: Mayuri-Gadsing <[email protected]>
Co-authored-by: James Suplizio <[email protected]>
Co-authored-by: Micah Bresette <[email protected]>
Co-authored-by: nasc17 <[email protected]>
Co-authored-by: Mike Harder <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Client This issue points to a problem in the data-plane of the library. data-plane KeyVault PublishToCustomers Acknowledgement the changes will be published to Azure customers. TypeSpec Authored with TypeSpec Versioning-Approved-Benign https://github.com/Azure/azure-sdk-tools/issues/6374
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants