Promote Microsoft.IoTOperations Private Preview Specs to Public Preview Repo #29374

hmmorales · 2024-06-10T16:40:48Z

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.

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:
- Promoting an typespec from the private preview repository into the public preview repository.
  https://github.com/Azure/azure-rest-api-specs-pr/tree/RPSaaSMaster/specification/iotoperations/resource-manager

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 · 2024-06-10T16:40:52Z

Next Steps to Merge

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

openapi-pipeline-app · 2024-06-10T16:40:52Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

️⌛Automated merging requirements met pending [Detail]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2024-06-10T16:40:53Z

PR validation pipeline restarted successfully. This comment will be populated with the 'Swagger Generation Artifacts' report

openapi-pipeline-app · 2024-06-10T16:40:53Z

Generated ApiView

Language	Package Name	ApiView Link
Swagger	Microsoft.IoTOperations	https://apiview.dev/Assemblies/Review/28a23a5dee3d4a07b5d4b256deb383d5?revisionId=bc494fd95301486c9a0d87088f0634f5
TypeSpec	IoTOperations.Management	https://apiview.dev/Assemblies/Review/0453fd959bbc4dbb9ee5a6266fb1ce29?revisionId=40e7f0a500344085b4f989bd5ad4a334

razvanbadea-msft · 2024-07-25T06:04:12Z

specification/iotoperations/IoTOperations.Management/tspconfig.yaml

+  extends:
+    - "@azure-tools/typespec-azure-rulesets/resource-manager"
+  disable:
+    "@azure-tools/typespec-azure-rulesets/resource-manager/arm-common-types-version": "New rule"


@azure-tools/typespec-azure-rulesets/resource-manager/arm-common-types-version": "New rule"

is this necessary?

i don't recall why we included this, removed it for now to see if typespec tests pass

specification/iotoperations/IoTOperations.Management/main.tsp

razvanbadea-msft · 2024-07-25T06:11:41Z

Fix errors from required checks

hmmorales · 2024-07-31T00:33:37Z

Accidently pushed all the changes to main on my branch.. thus why all the extra reviewers. Fixed it.

ms-bogdan-rotaru · 2024-07-31T10:50:02Z

Please fix the errors reported by Swagger ModelValidation check.

ms-bogdan-rotaru · 2024-07-31T10:50:57Z

Swagger LintDiff check is failing due to an existing issue - Azure/azure-openapi-validator#722

You can add temporary suppressions where applicable.

hmmorales · 2024-08-01T16:37:26Z

/pr RequestMerge

ms-bogdan-rotaru · 2024-08-02T07:34:34Z

/azp run

azure-pipelines · 2024-08-02T07:34:50Z

Azure Pipelines successfully started running 3 pipeline(s).

init

d4fbf5e

hmmorales added 2 commits July 23, 2024 16:36

Merge branch 'main' into aio-rp

762d121

copy over private specs

2bda83a

AzureRestAPISpecReview added new-rp-namespace resource-manager RPaaS SuppressionReviewRequired TypeSpec Authored with TypeSpec labels Jul 23, 2024

hmmorales marked this pull request as ready for review July 24, 2024 18:55

Merge branch 'main' into aio-rp

c249e55

hmmorales changed the title ~~AIO RP~~ Promote Microsoft.IoTOperations Private Preview Specs to Public Preview Repo Jul 24, 2024

AzureRestAPISpecReview added ARMReview new-api-version WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jul 24, 2024

razvanbadea-msft reviewed Jul 25, 2024

View reviewed changes

specification/iotoperations/IoTOperations.Management/main.tsp Show resolved Hide resolved

razvanbadea-msft added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jul 25, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 25, 2024

spellcheck

6c7f8aa

hmmorales requested review from weshaggard, mikeharder, benbp, msyyc, tadelesh and qiaozha as code owners July 31, 2024 00:15

hmmorales requested review from razvanbadea-msft and removed request for cRui861, wanghoppe, vicancy and johanste July 31, 2024 00:32

hmmorales removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jul 31, 2024

openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 31, 2024

ms-bogdan-rotaru added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jul 31, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 31, 2024

hmmorales added 5 commits July 31, 2024 09:47

resync examples and fix model validation

9a545ff

resource naming in examples

7ce1c19

prettier

8044c36

..

140f107

add suppression for failing pipeline

051d39e

AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Jul 31, 2024

hmmorales removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jul 31, 2024

openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 31, 2024

ms-bogdan-rotaru added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Aug 1, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 1, 2024

ms-bogdan-rotaru approved these changes Aug 1, 2024

View reviewed changes

microsoft-github-policy-service bot added the MergeRequested label Aug 1, 2024

ms-bogdan-rotaru added the Approved-Suppression label Aug 2, 2024

hmmorales merged commit eb323c0 into main Aug 2, 2024
29 of 30 checks passed

hmmorales deleted the aio-rp branch August 2, 2024 15:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Promote Microsoft.IoTOperations Private Preview Specs to Public Preview Repo #29374

Promote Microsoft.IoTOperations Private Preview Specs to Public Preview Repo #29374

hmmorales commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

razvanbadea-msft Jul 25, 2024

hmmorales Jul 31, 2024

razvanbadea-msft commented Jul 25, 2024

hmmorales commented Jul 31, 2024

ms-bogdan-rotaru commented Jul 31, 2024

ms-bogdan-rotaru commented Jul 31, 2024

hmmorales commented Aug 1, 2024

ms-bogdan-rotaru commented Aug 2, 2024

azure-pipelines bot commented Aug 2, 2024

Promote Microsoft.IoTOperations Private Preview Specs to Public Preview Repo #29374

Promote Microsoft.IoTOperations Private Preview Specs to Public Preview Repo #29374

Conversation

hmmorales commented Jun 10, 2024 • edited Loading

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

openapi-pipeline-app bot commented Jun 10, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Jun 10, 2024 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jun 10, 2024 • edited Loading

openapi-pipeline-app bot commented Jun 10, 2024 • edited Loading

Generated ApiView

razvanbadea-msft Jul 25, 2024

Choose a reason for hiding this comment

hmmorales Jul 31, 2024

Choose a reason for hiding this comment

razvanbadea-msft commented Jul 25, 2024

hmmorales commented Jul 31, 2024

ms-bogdan-rotaru commented Jul 31, 2024

ms-bogdan-rotaru commented Jul 31, 2024

hmmorales commented Aug 1, 2024

ms-bogdan-rotaru commented Aug 2, 2024

azure-pipelines bot commented Aug 2, 2024

hmmorales commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading