-
Notifications
You must be signed in to change notification settings - Fork 5.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Hub Generated] Review request for Microsoft.Devices to add version stable/2023-06-30 #23791
[Hub Generated] Review request for Microsoft.Devices to add version stable/2023-06-30 #23791
Conversation
Hi, @MikalaiSavenka 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.10.4)] | new version | base version |
---|---|---|
iothub.json | 2023-06-30(9c60f45) | 2021-07-02(main) |
iothub.json | 2023-06-30(9c60f45) | 2023-06-30-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.4) | new version | base version |
---|---|---|
package-2023-06 | package-2023-06(9c60f45) | 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 |
---|---|
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.Devices/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L60 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L61 |
DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L64 |
PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}' Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L76 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L76 |
DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L110 |
PutResponseSchemaDescription |
Description of 201 response code of a PUT operation MUST include term 'create'. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L165 |
DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L178 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L181 |
PatchResponseCode |
LRO PATCH must have 200 and 202 return codes. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L187 |
PatchIdentityProperty |
The patch operation body parameter schema should contain property 'identity'. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L218 |
PatchSkuProperty |
The patch operation body parameter schema should contain property 'sku'. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L218 |
LroPatch202 |
The async patch operation should return 202. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L231 |
MissingDefaultResponse |
Operation is missing a default response. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L231 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L231 |
DeleteResponseBodyEmpty |
The delete response body must be empty. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L291 |
MissingXmsErrorResponse |
Response code 404 is defined without a x-ms-error-response. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L298 |
NoErrorCodeResponses |
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L298 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L301 |
DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L304 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L307 |
PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs' Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L314 |
DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L342 |
PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs' Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L355 |
DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L386 |
PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats' Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L399 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L399 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L429 |
DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L433 |
PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus' Location: Microsoft.Devices/stable/2023-06-30/iothub.json#L443 |
️️✔️
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.
️️✔️
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).
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
Having name, subscriptionId, and resourceGroup, and id seems redundant - are they all identifying the same resource? Or are there diffeent resources here? In reply to: 1542562663 In reply to: 1542562663 Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3225 in 09336e3. [](commit_id = 09336e3, deletion_comment = False) |
Want to include an example? In reply to: 1542563183 In reply to: 1542563183 Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3215 in 09336e3. [](commit_id = 09336e3, deletion_comment = False) |
consider annotating as a resource id. x-ms-arm-id-details - indicates the allowed resources that can be referred to by an arm-id formatted string field. Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3217 in 09336e3. [](commit_id = 09336e3, deletion_comment = False) |
format: uri? In reply to: 1542565328 In reply to: 1542565328 Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3229 in 09336e3. [](commit_id = 09336e3, deletion_comment = False) |
Why is it required if PartitionKeyName is specified? In reply to: 1542566830 In reply to: 1542566830 In reply to: 1542566830 Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:3269 in 09336e3. [](commit_id = 09336e3, deletion_comment = False) |
Are you going to add an example for this? It'd be nice if your examples cover all the different kind of routing endpoints with a common set of parameters. In reply to: 1542569674 In reply to: 1542569674 Refers to: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/iothub.json:2952 in 09336e3. [](commit_id = 09336e3, deletion_comment = False) |
Added DoNotMerge at requet of PR author |
Hi, @MikalaiSavenka. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @MikalaiSavenka. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
Merge conflicts need resolving now.. |
Next Steps to Merge |
@rkmanda I wonder why powershell fails. Seems like its something to do wtih the tags in the readme maybe? Its a bit beyond me.
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
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.