[Hub Generated] Review request for Microsoft.DigitalTwins to add version stable/2023-01-31 #21643
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, @sjiherzig 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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| digitaltwins.json | 2023-01-31(0f20935) | 2022-10-31(main) |
| digitaltwins.json | 2023-01-31(0f20935) | 2021-06-30-preview(main) |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2023-01 | package-2023-01(0f20935) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L84 |
|
A 202 response should include an Location response header. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L194 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L208 |
|
The delete response body must be empty. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L240 |
|
A 202 response should include an Location response header. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L244 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L357 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L422 |
|
The delete response body must be empty. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L457 |
|
A 202 response should include an Location response header. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L461 |
|
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L773 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L817 |
|
A 202 response should include an Location response header. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L850 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L864 |
|
An async PUT operation must return 201. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L902 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L903 |
|
A 202 response should include an Location response header. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L903 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L1013 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L1075 |
|
The delete response body must be empty. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L1105 |
|
A 202 response should include an Location response header. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L1109 |
|
The schema 'DigitalTwinsResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L1260 |
|
The schema 'DigitalTwinsIdentity' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L1311 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L1389 |
|
The schema 'ErrorDefinition' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L1398 |
|
Missing identifier id in array item property Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L1411 |
|
Missing identifier id in array item property Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L1449 |
|
The schema 'DigitalTwinsEndpointResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L1661 |
|
The schema 'DigitalTwinsEndpointResourceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L1678 |
|
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L2007 |
|
The parameter 'subscriptionId' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json#L2244 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 7 Errors, 0 Warnings failed [Detail]
Tag package-2023-01; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 22, untested: 0, failed: 7, passed: 15
Service 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-LKQMDW-21643, ResourceName : resourcednrz8t state from Activating to Updating Source: runtime OperationId: DigitalTwins_Update |
|
statusCode: 400, errorCode: BadRequest, errorMessage: Cannot perform action while Digital Twins instance is in 'Activating' state. Instance must be in state 'Active'. Source: runtime OperationId: TimeSeriesDatabaseConnections_CreateOrUpdate |
|
statusCode: 404, errorCode: NotFound, errorMessage: The time series database connection was not found. Source: runtime OperationId: TimeSeriesDatabaseConnections_Get |
|
statusCode: 404, errorCode: NotFound, errorMessage: The resource was not found. Source: runtime OperationId: PrivateEndpointConnections_CreateOrUpdate |
|
statusCode: 404, errorCode: NotFound, errorMessage: The resource was not found. Source: runtime OperationId: PrivateEndpointConnections_Get |
|
statusCode: 404, errorCode: NotFound, errorMessage: The resource was not found. Source: runtime OperationId: PrivateLinkResources_Get |
|
statusCode: 404, errorCode: NotFound, errorMessage: The resource was not found. Source: runtime OperationId: PrivateEndpointConnections_Delete |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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.
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Nov 24, 2022
* Added lifecycle event tables and deletion option * Add examples, add deletion option * Add default value for recordPropertyAndItemRemovals
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @sjiherzig your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
|
API will be made available by early next year. |
raosuhas
reviewed
Dec 20, 2022
...ion/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2023-01-31/digitaltwins.json
Show resolved
Hide resolved
raosuhas
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
AzureRestAPISpecReview
added
the
ReadyForApiTest
|
Hi @sjiherzig as the new api version is '2023-01-31', if it's OK to merge this PR at 2023-01-31? Do you have another plan? |
|
@zzvswxy It's fine to merge - we still need to update the ARM manifest to make the version public, but I think the danger is low. You can go ahead and merge. |
sjiherzig
removed
the
DoNotMerge
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
openapi-pipeline-app
bot
added
the
DoNotMerge
zzvswxy
removed
the
DoNotMerge
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
openapi-pipeline-app
bot
added
DoNotMerge
|
Hi @tadelesh , can you help me to check the GO SDK breaking change? Thanks |
There is no Go breaking change. It is a false auto-added label. I've removed it. |
When both location & Azure-AsyncOperation headers are present, location is used first in API Test, as it's required header while the other is optional. The problem is when we poll with location header, if the operation is not completed, the location response should be 202, but the service returned 201. |
|
Hi @sjiherzig , do you think we can merge the PR? Or you want to merge it later when the ServiceAPIReadinessTest is passed. |
Interesting... my understanding of the ARM RPC is that Location is required only for PATCH, DELETE and POST, but not for PUT. For PUT, "Location" is only used if the service returns 202 on the initial request (and does not make the resource available immediately - i.e., a GET would still return 404). But if 200 or 201 is returned, it follows the "new" Azure-AsyncOp pattern. Is that not the correct interpretation @leni-msft ? We're sending the location header as a backup method, but maybe we should remove it entirely from PUT... it currently does not break CLI, SDK or Portal. |
Yes @zzvswxy, please merge it now, since we want to release the API version soon. |
zzvswxy
approved these changes
Feb 17, 2023
|
@sjiherzig You're right, for PUT operation, location header is not required. We can optimize the logic (maybe by distinguishing PUT and non-PUT operations) cc. @jianyexi for awareness. |
lirenhe
approved these changes
Feb 17, 2023
lirenhe
deleted the
dev-digitaltwins-Microsoft.DigitalTwins-2023-01-31
branch
This was referenced Feb 17, 2023
Closed
aviyerMSFT
pushed a commit
to aviyerMSFT/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2023
…ion stable/2023-01-31 (Azure#21643) * Adds base for updating Microsoft.DigitalTwins from version stable/2022-10-31 to version 2023-01-31 * Updates readme * Updates API version in new specs and examples * Added lifecycle event tables and deletion option (Azure#21644) * Added lifecycle event tables and deletion option * Add examples, add deletion option * Add default value for recordPropertyAndItemRemovals * Convert boolean into enum (Azure#22083)
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.