AIO M2 Spec Updates by hmmorales · Pull Request #30039 · Azure/azure-rest-api-specs

hmmorales · 2024-07-31T17:05:59Z

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:

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-07-31T17:06:03Z

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-07-31T17:06:04Z

Generated ApiView

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

* Audience, SecretRef, TLS * CloudEventAttributeType * x509 * update schema * PR feedback * schema update * key as well * remove MQ disable/enable * bring back broker * generate schema * format * make props read-only * remove mq * schema update * make togles read write * schema update * use mode flags * new line * switch to state * state

gary-x-li · 2024-08-14T00:18:14Z

Please fix the following errors:

❌ Swagger PrettierCheck
❌ Swagger LintDiff
❌ Swagger ModelValidation

* fix examples * fix * typo * instance examples * another typo

* remove Service accounts * update instance defintion * sync changes

* remove Service accounts * update instance defintion * sync changes * examples * examples * update second example * Instance schema and example update

specification/iotoperations/IoTOperations.Management/models/broker/listeners.tsp

* update examples * push other examples

* Adressed half * gen

* update batching * example gen

bilalsellak · 2024-08-14T22:47:53Z

There are 2 batching types @hmmorales @nonsocode

For fabric, datalake, and dataexplorer:
batching:
latencySeconds: (default of 60)
maxMessages: (default of 100000)

For Kafka:
batching:
latencyMs: (default of 5)
maxBytes: (default of 1000000)
maxMessages: (default of 100000)
mode: (default of Enabled)

Based off of this, and looking at the typespec, it looks correct

* Revert "Model validation pass 4 (#30220)" This reverts commit d73c5c8. * ...

hmmorales · 2024-08-14T23:45:20Z

/azp run

azure-pipelines · 2024-08-14T23:45:36Z

Azure Pipelines successfully started running 3 pipeline(s).

gary-x-li · 2024-08-15T14:07:19Z

specification/iotoperations/IoTOperations.Management/models/instance.tsp

+  };
+
+  @doc("The properties of the dataflows instance.")
+  dataflows?: DataFlowInstanceProperties = #{ state: OperationalMode.Enabled };


DataFlowInstanceProperties

Should it be DataflowInstanceProperties? You've changed the casing in this PR but there're a couple in this file with an uppercase F.

gary-x-li · 2024-08-15T14:09:09Z

specification/iotoperations/IoTOperations.Management/models/dataflows/dataflowEndpoints.tsp

+}
+
+@doc("Kafka endpoint Authentication properties. NOTE - only authentication property is allowed per entry")
+model DataFlowEndpointKafkaAuthentication {


DataFlowEndpointKafkaAuthentication

Dataflow...?

gary-x-li · 2024-08-15T14:18:18Z

specification/iotoperations/resource-manager/readme.md

    reason: User defined properties that are not subject to any validations.
  - suppress: BodyTopLevelProperties
    reason: Temporary suppression due to failing pipeline.
+  - suppress: PatchBodyParametersSchema


PatchBodyParametersSchema

Can you specify where property here instead of suppressing globally?

* fix: Lowercase d in dataflow * uncomment supression * supress path * schema * drill down * stop at identity * run gen

init PR

79a3cf9

Merge branch 'main' into release/0.7.0-preview

87fa923

hmmorales changed the title ~~init PR~~ AIO M2 Spec Updates Aug 6, 2024

remove placeholder

8a31865

nonsocode and others added 2 commits August 13, 2024 15:44

Add dataflow examples (#30192)

7084075

hmmorales and others added 3 commits August 13, 2024 17:19

fix examples (#30195)

a4a0497

* fix examples * fix * typo * instance examples * another typo

fix: Remove service accounts from instance (#30198)

cb4438b

* remove Service accounts * update instance defintion * sync changes

fix: re-add Instance examples to (#30199)

23df743

* remove Service accounts * update instance defintion * sync changes * examples * examples * update second example * Instance schema and example update

nonsocode reviewed Aug 14, 2024

View reviewed changes

specification/iotoperations/IoTOperations.Management/models/broker/listeners.tsp Show resolved Hide resolved

nonsocode and others added 12 commits August 14, 2024 09:07

chore: Fix typos in Aio types (#30205)

4c7d606

fix: Rename secretName to secretRef (#30208)

091a472

suppression (#30209)

1a09ca5

fix secretName (#30211)

b7dfde4

fix: update examples (#30212)

1c3d569

* update examples * push other examples

typo (#30213)

eeaa77f

fix: Adressed half of the issues (#30216)

f06c2b2

* Adressed half * gen

model validation pass

3388a0d

model validation (#30218)

9eed678

201 (#30219)

10ba7d1

fix

95fc669

Model validation pass 4 (#30220)

d73c5c8

* update batching * example gen

Model validation pass 5 (#30221)

615bc3c

* Revert "Model validation pass 4 (#30220)" This reverts commit d73c5c8. * ...

chgennar approved these changes Aug 15, 2024

View reviewed changes

nonsocode approved these changes Aug 15, 2024

View reviewed changes

gary-x-li reviewed Aug 15, 2024

View reviewed changes

fix: lower case d (#30236)

f922a3f

* fix: Lowercase d in dataflow * uncomment supression * supress path * schema * drill down * stop at identity * run gen

nonsocode approved these changes Aug 15, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AIO M2 Spec Updates#30039

AIO M2 Spec Updates#30039
hmmorales merged 50 commits intomainfrom
release/0.7.0-preview

hmmorales commented Jul 31, 2024 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Jul 31, 2024 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Jul 31, 2024 •

edited

Loading

Uh oh!

gary-x-li commented Aug 14, 2024

Uh oh!

Uh oh!

bilalsellak commented Aug 14, 2024

Uh oh!

hmmorales commented Aug 14, 2024

Uh oh!

azure-pipelines bot commented Aug 14, 2024

Uh oh!

gary-x-li Aug 15, 2024

Uh oh!

gary-x-li Aug 15, 2024

Uh oh!

gary-x-li Aug 15, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Conversation

hmmorales commented Jul 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

Uh oh!

openapi-pipeline-app bot commented Jul 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Next Steps to Merge

Uh oh!

openapi-pipeline-app bot commented Jul 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated ApiView

Uh oh!

gary-x-li commented Aug 14, 2024

Uh oh!

Uh oh!

bilalsellak commented Aug 14, 2024

Uh oh!

hmmorales commented Aug 14, 2024

Uh oh!

azure-pipelines bot commented Aug 14, 2024

Uh oh!

gary-x-li Aug 15, 2024

Choose a reason for hiding this comment

Uh oh!

gary-x-li Aug 15, 2024

Choose a reason for hiding this comment

Uh oh!

gary-x-li Aug 15, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

hmmorales commented Jul 31, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jul 31, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jul 31, 2024 •

edited

Loading