[Hub Generated] Review request for Microsoft.DigitalTwins to add version stable/2022-05-31 #20669
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @dejimarquis Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| digitaltwins.json | 2022-05-31(281434c) | 2022-05-31(main) |
| Rule | Message |
|---|---|
|
The new version has a different default value than the previous one. New: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L2106:9 Old: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L2106:9 |
|
The new version has a different default value than the previous one. New: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L2124:9 Old: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L2123:9 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-05 | package-2022-05(281434c) | package-2022-05(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The schema 'DigitalTwinsResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L1251 |
|
The schema 'DigitalTwinsIdentity' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L1302 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L1331 |
|
The schema 'ErrorDefinition' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L1340 |
|
The schema 'DigitalTwinsEndpointResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L1603 |
|
The schema 'DigitalTwinsEndpointResourceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L1620 |
|
Missing identifier id in array item property Location: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L1353 |
|
Missing identifier id in array item property Location: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L1391 |
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L1244 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L1842 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L2002 |
|
| Based on the response model schema, operation 'PrivateLinkResources_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L642 |
|
| Based on the response model schema, operation 'PrivateEndpointConnections_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L729 |
|
| The child tracked resource, 'endpoints' with immediate parent 'DigitalTwinsDescription', must have a list by immediate parent operation. Location: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L1603 |
|
| The child tracked resource, 'privateLinkResources' with immediate parent 'DigitalTwinsDescription', must have a list by immediate parent operation. Location: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L1838 |
|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'DigitalTwinsDescription', must have a list by immediate parent operation. Location: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L1981 |
|
| The child tracked resource, 'timeSeriesDatabaseConnections' with immediate parent 'DigitalTwinsDescription', must have a list by immediate parent operation. Location: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L2061 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json#L1420 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 14 Errors, 0 Warnings failed [Detail]
Test run on tag: package-2022-05, operation coverage: 22/22, failed operations: 7Service API Readiness Test failed. Check pipeline artifact for detail report.
| Rule | Message |
|---|---|
|
"statusCode: 409, errorCode: Conflict, errorMessage: Can't update instance SubscriptionId: db5eb68e-73e2-4fa8-b18a-46cd1be4cce5, ResourceGroup: apiTest-vjnMdz, ResourceName : resourcenaq2fwy4 state from Activating to Updating" |
|
"expected response code to be 2XX but found 409" |
|
"statusCode: 400, errorCode: BadRequest, errorMessage: Cannot perform action while Digital Twins instance is in 'Activating' state. Instance must be in state 'Active'." |
|
"expected response code to be 2XX but found 400" |
|
"statusCode: 404, errorCode: NotFound, errorMessage: The time series database connection was not found." |
|
"expected response code to be 2XX but found 404" |
|
"statusCode: 404, errorCode: NotFound, errorMessage: The resource was not found." |
|
"expected response code to be 2XX but found 404" |
|
"statusCode: 404, errorCode: NotFound, errorMessage: The resource was not found." |
|
"expected response code to be 2XX but found 404" |
|
"statusCode: 404, errorCode: NotFound, errorMessage: The resource was not found." |
|
"expected response code to be 2XX but found 404" |
|
"statusCode: 404, errorCode: NotFound, errorMessage: The resource was not found." |
|
"expected response code to be 2XX but found 404" |
️⚠️~[Staging] TrafficValidation: 1 Warnings warning [Detail]
restlerResult: Request coverage (successful / total): 7 / 22 Attempted requests: 10 / 22
Traffic validation failed. Check pipeline artifact for restler output and detail report.
| Rule | Message |
|---|---|
| "Starting task Test...\nUsing python: 'python3' (Python 3.10.5)\nRequest coverage (successful / total): 7 / 22\nAttempted requests: 10 / 22\nNo bugs were found.\nTask Test succeeded.\nCollecting logs...\n" |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/281434c921f149334a3a2b41ce201bd50df12ba1/specification/digitaltwins/resource-manager/readme.md#tag-package-2022-05">digitaltwins/resource-manager/readme.md#package-2022-05
| Rule | Message |
|---|---|
| "readme":"digitaltwins/resource-manager/readme.md", "tag":"package-2022-05", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Sep 9, 2022
|
Please note that this PR adds a default value annotation in response to a Swagger Correctness alert. The service has always been producing a default value for adxTableName and eventHubConsumerGroup, but it was previously not explicitly specified in the swagger. |
JeffreyRichter
added
the
Approved-BreakingChange
leni-msft
approved these changes
Sep 30, 2022
This was referenced Sep 30, 2022
Closed
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Sep 30, 2022
….DigitalTwins to add version stable/2022-05-31 (#2585) Create to sync Azure/azure-rest-api-specs#20669 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/digitaltwins?expand=1)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.