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

Replace @extension("x-ms-identifiers", []) with @identifiers decorator #32741

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

Conversation

AlitzelMendez
Copy link
Member

ARM (Control Plane) API Specification Update Pull Request

Tip

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

PR review workflow diagram

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

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

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
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • 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.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • 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 Feb 20, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR has breaking changes in the generated SDK for JavaScript (label: BreakingChange-JavaScript-Sdk). Refer to step 3 in the PR workflow diagram.
  • ❌ Your PR has breaking changes in the generated SDK for Python (label: BreakingChange-Python-Sdk). Refer to step 3 in the PR workflow diagram.
  • ❌ The required check named TypeSpec Validation 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

Copy link

openapi-pipeline-app bot commented Feb 20, 2025

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/servicenetworking/armservicenetworking There is no API change compared with the previous version
JavaScript @azure/arm-servicenetworking https://apiview.dev/Assemblies/Review/78fd700d950f45129790c97f9171efdc?revisionId=62148f9baac545188347fcccc4d4d270
.Net Azure.ResourceManager.AgriculturePlatform https://apiview.dev/Assemblies/Review/2f0a9b9baee9437bbd8036e664b89d6c?revisionId=4e9619a2727f41168c5826032c7e420d
.Net Azure.ResourceManager.DatabaseWatcher https://apiview.dev/Assemblies/Review/692c3ca38a124cf599e624d760121724?revisionId=b81da9d19d4f4d38ac2d89abd4b7f7f3
.Net Azure.ResourceManager.DevOpsInfrastructure https://apiview.dev/Assemblies/Review/29126cc9281244a6b6994267d158014e?revisionId=f060a55e6c0448019234f1e956188107
.Net Azure.ResourceManager.DeviceRegistry There is no API change compared with the previous version
.Net Azure.ResourceManager.Impact https://apiview.dev/Assemblies/Review/987727dec37441928f79ed7bc97a430c?revisionId=692fe567f88342c5a00ab357ca68c5a4
.Net Azure.ResourceManager.MongoCluster https://apiview.dev/Assemblies/Review/069e466f47da47f793462e050d4cf99f?revisionId=14566c1091e2484185cd5ae30c06352e
.Net Azure.ResourceManager.Terraform https://apiview.dev/Assemblies/Review/917692ad180248b996b8631b04664220?revisionId=8f602d36a2cf4ce2af70e765f84ea24a
Java azure-resourcemanager-computefleet There is no API change compared with the previous version
Java azure-resourcemanager-computeschedule There is no API change compared with the previous version
Java azure-resourcemanager-containerservicefleet https://apiview.dev/Assemblies/Review/8422e73bfd5d45efb77d0cf066bec1a0?revisionId=2a0de599230141e5913894449d8714d3
Java azure-resourcemanager-databasewatcher https://apiview.dev/Assemblies/Review/5346d598691c4bbf9428cd756f1bf88b?revisionId=94aaf10ad2f846acb57185b0d46d0a83
Java azure-resourcemanager-deviceregistry https://apiview.dev/Assemblies/Review/90da387f53324bba89095f644611247c?revisionId=57c4f421f52b47ec8f411a5e778c5e30
Java azure-resourcemanager-devopsinfrastructure https://apiview.dev/Assemblies/Review/43a6bc3c665749fea7eb1ea191b80cc4?revisionId=75955dd2cc184dec900fa3c09f19a1b8
Java azure-resourcemanager-impactreporting There is no API change compared with the previous version
Java azure-resourcemanager-iotoperations There is no API change compared with the previous version
Java azure-resourcemanager-mongocluster https://apiview.dev/Assemblies/Review/89671bc422414e0f9adb9c49282e7e7f?revisionId=7e55c3f009b44f37a2148c58ab48a6d8
Java azure-resourcemanager-servicenetworking There is no API change compared with the previous version
Java azure-resourcemanager-standbypool https://apiview.dev/Assemblies/Review/db61bbdc351a4234b7d5a9ed198917d0?revisionId=72aab188159e484eb5d833c98a47cd9f
Java azure-resourcemanager-terraform https://apiview.dev/Assemblies/Review/08da9e2c15c743569b06127f7673f6e0?revisionId=2b0af3b73f38448590271a420a92ff68
Java azure-resourcemanager-trustedsigning https://apiview.dev/Assemblies/Review/9d10da6041f14593be143ffd3e4a6728?revisionId=845e460c51b64936a042226b7afd7c28
Python azure-mgmt-appcomplianceautomation https://apiview.dev/Assemblies/Review/4224fc3a45d141aab0a36b131be6058f?revisionId=8656b0cd317a40439d58ac9e2600cf58
Python azure-mgmt-chaos https://apiview.dev/Assemblies/Review/1ecb88be1a6d4dc08cf40890089b6bed?revisionId=529d6098d8ad4b67beb1ca4c5514f40d
Python azure-mgmt-computefleet https://apiview.dev/Assemblies/Review/de88f66df5714d2c9884ddea5491a9bf?revisionId=891c895110cf4150bfa426d8d84dd8b3
Python azure-mgmt-computeschedule https://apiview.dev/Assemblies/Review/014ca20ab0e54bcd8fc128970bb46740?revisionId=5d675b6c3e5f49b1bce649f06c9a6062
Python azure-mgmt-databasewatcher https://apiview.dev/Assemblies/Review/6dd20d7f65e948c683dcdf0a25c6be09?revisionId=6a4dfaea6ec84c8eb7589b0377491b54
Python azure-mgmt-deviceregistry https://apiview.dev/Assemblies/Review/bfa2420ec3d3453bab14fc06ab547013?revisionId=9af4c95064f34548addbb5b237311ff0
Python azure-mgmt-devopsinfrastructure https://apiview.dev/Assemblies/Review/8029f27f8b024d58a85239373fd68b56?revisionId=aba9a4baceb74fbbb99e97b60aa6f39a
Python azure-mgmt-impactreporting https://apiview.dev/Assemblies/Review/39d2c058d9464412adf50026b7966a0e?revisionId=c2c8091d149b43a9a495e846e39e15c8
Python azure-mgmt-informaticadatamanagement https://apiview.dev/Assemblies/Review/8d5cb66ede1d41849dd441a8cc497c42?revisionId=2ed7cd9a25d04095974e576f7c3937dc
Python azure-mgmt-iotoperations https://apiview.dev/Assemblies/Review/769883b1547944f0b54d7e35ce415ee3?revisionId=5efdc7eaec98467b8d7028a2e3d63b6f
Python azure-mgmt-loadtesting https://apiview.dev/Assemblies/Review/c1ee94ca12334cc5bfb6bfb7de42b1e6?revisionId=c27d95d5d7714325aadbae954b3f1729
Python azure-mgmt-migrationdiscoverysap https://apiview.dev/Assemblies/Review/b85a1bb0c55342828f6c9f992a8dfcf2?revisionId=e1c5c4483a844c589966e0f878f9bda1
Python azure-mgmt-mongocluster https://apiview.dev/Assemblies/Review/95ef88f78ac94e2d8b0678bb3433e223?revisionId=c473f6cfdb7a4b0d88c02c894e1d84f4
Python azure-mgmt-monitor https://apiview.dev/Assemblies/Review/6b51e5aecafc4a6da8b9ff679b6855b5?revisionId=7aa9487eb49d4813b40a94273d7c0e43
Python azure-mgmt-scvmm https://apiview.dev/Assemblies/Review/f611cb3bfaa34c5394a2de8e030c2e6a?revisionId=12aa80d5b5db4826a417fd043dc499b0
Python azure-mgmt-servicenetworking https://apiview.dev/Assemblies/Review/eaf5055b29fb4fdeb0e50b2f132f6bb2?revisionId=2a7da0dbf791456c8d934e8488980910
Python azure-mgmt-standbypool https://apiview.dev/Assemblies/Review/65b9e4ec19b14385be1a9f20f3b6044d?revisionId=9247b4b577854be587934635e28323f7
Python azure-mgmt-terraform https://apiview.dev/Assemblies/Review/e33e011f9f0942bb99db731321812768?revisionId=1be9decf2bb24f86bc23df36e4a1cdc2
Python azure-mgmt-trustedsigning https://apiview.dev/Assemblies/Review/dc54abdcd8c848fc9d7e736f62475bfb?revisionId=bb8743017fc6425c9597516b8b06a347

@AzureRestAPISpecReview AzureRestAPISpecReview added the TypeSpec Authored with TypeSpec label Feb 20, 2025
This was referenced Feb 20, 2025
@AlitzelMendez
Copy link
Member Author

block as some sdk generators are not using the version with the decorator, opened prs to get this updated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants