-
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
Databoxedge march release #18374
Databoxedge march release #18374
Conversation
Hi, @amishra31 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] |
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
Rule | Message |
---|---|
Per the Noun_Verb convention for Operation Ids, the noun 'DeviceCapacityInfo' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L789 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'DeviceCapacityInfoModel'. Consider using the plural form of 'DeviceCapacityInfo' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L789 |
|
OperationId should contain the verb: 'devicecapacitycheck' in:'DeviceCapacityCheck_CheckResourceCreationFeasibility'. Consider updating the operationId Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L723 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isFeasible Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L9730 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L3161 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L3407 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L189 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L236 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L292 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L340 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L395 |
R4039 - ParametersOrder |
The parameters:deviceName,name,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L444 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L497 |
R4039 - ParametersOrder |
The parameters:deviceName,name,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L546 |
R4039 - ParametersOrder |
The parameters:deviceName,name,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L597 |
R4039 - ParametersOrder |
The parameters:deviceName,name,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L661 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L830 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L874 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L933 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L977 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L1036 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L1083 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L1129 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L1175 |
R4039 - ParametersOrder |
The parameters:deviceName,name,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L1222 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L1275 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L1321 |
R4039 - ParametersOrder |
The parameters:deviceName,name,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L1370 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L1423 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L1472 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L1516 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L1573 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L1623 |
R4039 - ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L1669 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌
~[Staging] ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
API Readiness check failed. Please make sure your service is deployed. |
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.DataBoxEdge' for api version '2022-03-01'. The supported api-versions are '2017-09-01, 2018-07-01, 2019-03-01, 2019-07-01, 2019-08-01, 2020-01-01, 2020-05-01-preview, 2020-06-01, 2020-07-01, 2020-07-01-preview, 2020-09-01, 2020-09-01-preview, 2020-12-01, 2021-02-01-preview, 2021-02-01, 2021-06-01, 2021-06-01-preview'." |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️
Cross-Version Breaking Changes: 2 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.9.3)
- current:stable/2022-03-01/databoxedge.json compared with base:stable/2021-06-01/databoxedge.json
- current:stable/2022-03-01/databoxedge.json compared with base:preview/2021-06-01-preview/databoxedge.json
Rule | Message |
---|---|
The new version has new required property 'contactInformation' that was not found in the old version. New: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L7884:9 Old: Microsoft.DataBoxEdge/preview/2021-06-01-preview/databoxedge.json#L7331:9 |
|
The new version has new required property 'contactInformation' that was not found in the old version. New: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L7912:5 Old: Microsoft.DataBoxEdge/preview/2021-06-01-preview/databoxedge.json#L7358:5 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️
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).
Swagger Generation Artifacts
|
Hi, @amishra31 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
Hey, my changes for adding new API version are done. Could the team please review? @lirenhe tagging you here as unable to reach you on teams. |
...cation/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json
Outdated
Show resolved
Hide resolved
...cation/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json
Outdated
Show resolved
Hide resolved
...cation/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json
Show resolved
Hide resolved
Hi @lirenhe, seems like SDK for Js looks like an infra problem. In swagger pipeline I can see a memory issue error. Could you please check? I can see the same error when I check the swagger for previous api versions also. We want to go ahead with the release so are on a tight schedule. |
The JS SDK should be fine and here is the PR for JS SDK AzureSDKAutomation/azure-sdk-for-js#8263 |
* Initial Commit * 2022-03-01 * Fix Breaking Changes * Revert Readonly properties * Add capacity Name * Run Prettier Fix * Address ARM review comments * Reorder Swagger * Fix Delete call * Restore long running op * Enrich example Co-authored-by: Abhishek Mishra <[email protected]>
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
-March End.
Contribution checklist:
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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.