Skip to content

Conversation

@adityareddy305
Copy link
Member

@adityareddy305 adityareddy305 commented Oct 15, 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:
    • moving from private repository to public repository as part of public preview

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.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 15, 2024

Next Steps to Merge

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

@adityareddy305
Copy link
Member Author

adityareddy305 commented Oct 16, 2024

@ramoka178
Copy link
Contributor

The Swagger jsons match till today.
@adityareddy305 Please fix the Typespec validation and LintDiff errors . If LintDIff cannot be fixed, for your case, try adding suppressions

@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
@TimLovellSmith
Copy link
Member

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 2 pipeline(s).

@TimLovellSmith
Copy link
Member

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 2 pipeline(s).

@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 Nov 2, 2024
@openapi-pipeline-app openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 3, 2024
@raosuhas raosuhas added Approved-Suppression ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels Nov 6, 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 Nov 6, 2024
@adityareddy305 adityareddy305 added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Nov 7, 2024
@adityareddy305 adityareddy305 self-assigned this Nov 8, 2024
@adityareddy305 adityareddy305 removed the request for review from TimLovellSmith November 11, 2024 13:06
@adityareddy305 adityareddy305 merged commit c6774d9 into Azure:main Nov 11, 2024
pjpatel12 pushed a commit to pjpatel12/azure-rest-api-specs that referenced this pull request Apr 29, 2025
…1037)

* moving from private to public

* add existing spec and fix type spec

* add existing spec and fix type spec

* Fix: Add versioned dependencies and format impact.tsp

* suppress provisioning status read only

* suppress provisioning status read only

* suppress aditional properties

* suppress aditional properties

* add readOnly for provisioning status

* supression for additional properties

* add readonly to provisioning state

* add readOnly

* add supressions

* supression and correct example files

* suppress guid message

* remove cadl files

* revert to existing spec

* fix type spec validation

* add only new version for public preview

* remove supressions

* add supressions

* remove track1 sdk as it was deprecated

* remove track1 sdk as it was deprecated

* remove suppression comment from typespec file

* add supression
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Approved-Suppression ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review new-api-version new-rp-namespace PublishToCustomers Acknowledgement the changes will be published to Azure customers. ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager RPaaS SuppressionReviewRequired TypeSpec Authored with TypeSpec

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants