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

use v3 common-types #31063

Conversation

jiaqi-beep
Copy link
Member

@jiaqi-beep jiaqi-beep commented Oct 16, 2024

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 Oct 16, 2024

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 Oct 16, 2024

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/hybridcompute/armhybridcompute https://apiview.dev/Assemblies/Review/cc99eb4c91204d199d8e40aed71bc06e?revisionId=ab288462d22f4b989b814208e80f0b73
JavaScript @azure/arm-hybridcompute https://apiview.dev/Assemblies/Review/bd79793b6b53409d8de21847c605dc64?revisionId=2feacb9882d24e2d99117919273c9aed
Java azure-resourcemanager-hybridcompute https://apiview.dev/Assemblies/Review/b79886348ebe497b9ddc99d286cb6e99?revisionId=ace72f0cf9274bb4a8482e803a350570
.Net Azure.ResourceManager.HybridCompute There is no API change compared with the previous version
Swagger Microsoft.HybridCompute https://apiview.dev/Assemblies/Review/31dae74112a04fb7b3a4a58e2c398536?revisionId=9c62882aaac345bbad03371beb46c439

@ramoka178
Copy link
Contributor

@jiaqi-beep Could you please comment on this revert to v3 , as v5 is highly suggested.

@ramoka178 ramoka178 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 22, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 22, 2024
@jiaqi-beep
Copy link
Member Author

jiaqi-beep commented Oct 22, 2024

@jiaqi-beep Could you please comment on this revert to v3 , as v5 is highly suggested.

This change is a result of breaking change cross version check failure #30546, and discussion with @mikeharder suggests we should unify common type versions. We are converting to v3 because most of the existing common type usage is in v3, only a handful in v5. Also attempting to convert common types to v5 triggers more cross version check failures.

Could you explain why v5 is highly suggested?

@jiaqi-beep jiaqi-beep added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 22, 2024
@ramoka178 ramoka178 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 24, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 24, 2024
@vedkale vedkale removed the request for review from mikeharder October 25, 2024 01:53
@jiaqi-beep jiaqi-beep merged commit 8347c9a into release-hybridcompute-Microsoft.HybridCompute-2024-09-10-preview Oct 25, 2024
26 of 27 checks passed
@jiaqi-beep jiaqi-beep deleted the v3-common-types branch October 25, 2024 17:44
vedkale added a commit that referenced this pull request Nov 11, 2024
…0546)

* Copy files from preview/2024-07-31-preview

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

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

Updated the API version from preview/2024-07-31-preview to preview/2024-09-10-preview.

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

* add extension setup API and example (#30592)

* add extension setup API and example

---------

Co-authored-by: Ved Kale <[email protected]>

* use v3 common-types (#31063)

* use v3 common-types

* prettier

* attempt v5 common types

This reverts commit 9925d24.

* Revert "attempt v5 common types"

This reverts commit 4ed6fa4.

* update to v5

* update subscriptionid to guid format in examples

* fix examples in machines

* Revert "fix examples in machines"

This reverts commit cf84a91.

* fix model validation

* fix model validation

* prettier

* prettier

* prettier

* Revert "prettier"

This reverts commit ea820f1.

* Revert "prettier"

This reverts commit 68b5bb6.

* Revert "prettier"

This reverts commit e5065de.

* Revert "fix model validation"

This reverts commit 4b0723f.

* Revert "fix model validation"

This reverts commit 9ad91b4.

* Reapply "fix examples in machines"

This reverts commit 8f00a27.

* Revert "fix examples in machines"

This reverts commit cf84a91.

* Revert "update subscriptionid to guid format in examples"

This reverts commit 8f1af4d.

* Revert "update to v5"

This reverts commit e0083cf.

* Reapply "attempt v5 common types"

This reverts commit 3df6b50.

* Reapply "dummy change to trigger checks"

This reverts commit 0956f17.

* Revert "dummy change to trigger checks"

This reverts commit 9925d24.

* use v3 common type

* Update sdk-suppressions.yaml

---------

Co-authored-by: Jiaqi Li <[email protected]>
Co-authored-by: Yuchao Yan <[email protected]>

* Microsoft.HybridCompute-2024-09-10-preview update API and swagger with better naming (#31346)

Co-authored-by: Ved Kale <[email protected]>

---------

Co-authored-by: Ved Kale <[email protected]>
Co-authored-by: jiaqi-beep <[email protected]>
Co-authored-by: Jiaqi Li <[email protected]>
Co-authored-by: Yuchao Yan <[email protected]>
mikeharder pushed a commit to mikeharder/azure-rest-api-specs that referenced this pull request Nov 13, 2024
…ure#30546)

* Copy files from preview/2024-07-31-preview

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

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

Updated the API version from preview/2024-07-31-preview to preview/2024-09-10-preview.

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

* add extension setup API and example (Azure#30592)

* add extension setup API and example

---------

Co-authored-by: Ved Kale <[email protected]>

* use v3 common-types (Azure#31063)

* use v3 common-types

* prettier

* attempt v5 common types

This reverts commit 9925d24.

* Revert "attempt v5 common types"

This reverts commit 4ed6fa4.

* update to v5

* update subscriptionid to guid format in examples

* fix examples in machines

* Revert "fix examples in machines"

This reverts commit cf84a91.

* fix model validation

* fix model validation

* prettier

* prettier

* prettier

* Revert "prettier"

This reverts commit ea820f1.

* Revert "prettier"

This reverts commit 68b5bb6.

* Revert "prettier"

This reverts commit e5065de.

* Revert "fix model validation"

This reverts commit 4b0723f.

* Revert "fix model validation"

This reverts commit 9ad91b4.

* Reapply "fix examples in machines"

This reverts commit 8f00a27.

* Revert "fix examples in machines"

This reverts commit cf84a91.

* Revert "update subscriptionid to guid format in examples"

This reverts commit 8f1af4d.

* Revert "update to v5"

This reverts commit e0083cf.

* Reapply "attempt v5 common types"

This reverts commit 3df6b50.

* Reapply "dummy change to trigger checks"

This reverts commit 0956f17.

* Revert "dummy change to trigger checks"

This reverts commit 9925d24.

* use v3 common type

* Update sdk-suppressions.yaml

---------

Co-authored-by: Jiaqi Li <[email protected]>
Co-authored-by: Yuchao Yan <[email protected]>

* Microsoft.HybridCompute-2024-09-10-preview update API and swagger with better naming (Azure#31346)

Co-authored-by: Ved Kale <[email protected]>

---------

Co-authored-by: Ved Kale <[email protected]>
Co-authored-by: jiaqi-beep <[email protected]>
Co-authored-by: Jiaqi Li <[email protected]>
Co-authored-by: Yuchao Yan <[email protected]>
digvijaymali94 pushed a commit to digvijaymali94/azure-rest-api-specs that referenced this pull request Dec 17, 2024
…ure#30546)

* Copy files from preview/2024-07-31-preview

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

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

Updated the API version from preview/2024-07-31-preview to preview/2024-09-10-preview.

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

* add extension setup API and example (Azure#30592)

* add extension setup API and example

---------

Co-authored-by: Ved Kale <[email protected]>

* use v3 common-types (Azure#31063)

* use v3 common-types

* prettier

* attempt v5 common types

This reverts commit 9925d24.

* Revert "attempt v5 common types"

This reverts commit 4ed6fa4.

* update to v5

* update subscriptionid to guid format in examples

* fix examples in machines

* Revert "fix examples in machines"

This reverts commit cf84a91.

* fix model validation

* fix model validation

* prettier

* prettier

* prettier

* Revert "prettier"

This reverts commit ea820f1.

* Revert "prettier"

This reverts commit 68b5bb6.

* Revert "prettier"

This reverts commit e5065de.

* Revert "fix model validation"

This reverts commit 4b0723f.

* Revert "fix model validation"

This reverts commit 9ad91b4.

* Reapply "fix examples in machines"

This reverts commit 8f00a27.

* Revert "fix examples in machines"

This reverts commit cf84a91.

* Revert "update subscriptionid to guid format in examples"

This reverts commit 8f1af4d.

* Revert "update to v5"

This reverts commit e0083cf.

* Reapply "attempt v5 common types"

This reverts commit 3df6b50.

* Reapply "dummy change to trigger checks"

This reverts commit 0956f17.

* Revert "dummy change to trigger checks"

This reverts commit 9925d24.

* use v3 common type

* Update sdk-suppressions.yaml

---------

Co-authored-by: Jiaqi Li <[email protected]>
Co-authored-by: Yuchao Yan <[email protected]>

* Microsoft.HybridCompute-2024-09-10-preview update API and swagger with better naming (Azure#31346)

Co-authored-by: Ved Kale <[email protected]>

---------

Co-authored-by: Ved Kale <[email protected]>
Co-authored-by: jiaqi-beep <[email protected]>
Co-authored-by: Jiaqi Li <[email protected]>
Co-authored-by: Yuchao Yan <[email protected]>
grangasamy-msft pushed a commit that referenced this pull request Feb 5, 2025
…0546)

* Copy files from preview/2024-07-31-preview

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

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

Updated the API version from preview/2024-07-31-preview to preview/2024-09-10-preview.

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

* add extension setup API and example (#30592)

* add extension setup API and example

---------

Co-authored-by: Ved Kale <[email protected]>

* use v3 common-types (#31063)

* use v3 common-types

* prettier

* attempt v5 common types

This reverts commit 9925d24.

* Revert "attempt v5 common types"

This reverts commit 4ed6fa4.

* update to v5

* update subscriptionid to guid format in examples

* fix examples in machines

* Revert "fix examples in machines"

This reverts commit cf84a91.

* fix model validation

* fix model validation

* prettier

* prettier

* prettier

* Revert "prettier"

This reverts commit ea820f1.

* Revert "prettier"

This reverts commit 68b5bb6.

* Revert "prettier"

This reverts commit e5065de.

* Revert "fix model validation"

This reverts commit 4b0723f.

* Revert "fix model validation"

This reverts commit 9ad91b4.

* Reapply "fix examples in machines"

This reverts commit 8f00a27.

* Revert "fix examples in machines"

This reverts commit cf84a91.

* Revert "update subscriptionid to guid format in examples"

This reverts commit 8f1af4d.

* Revert "update to v5"

This reverts commit e0083cf.

* Reapply "attempt v5 common types"

This reverts commit 3df6b50.

* Reapply "dummy change to trigger checks"

This reverts commit 0956f17.

* Revert "dummy change to trigger checks"

This reverts commit 9925d24.

* use v3 common type

* Update sdk-suppressions.yaml

---------

Co-authored-by: Jiaqi Li <[email protected]>
Co-authored-by: Yuchao Yan <[email protected]>

* Microsoft.HybridCompute-2024-09-10-preview update API and swagger with better naming (#31346)

Co-authored-by: Ved Kale <[email protected]>

---------

Co-authored-by: Ved Kale <[email protected]>
Co-authored-by: jiaqi-beep <[email protected]>
Co-authored-by: Jiaqi Li <[email protected]>
Co-authored-by: Yuchao Yan <[email protected]>
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.

6 participants