-
Notifications
You must be signed in to change notification settings - Fork 5.5k
New API preview version 2021-06-01and preview changes #15929
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
New API preview version 2021-06-01and preview changes #15929
Conversation
…-01-stable-preview added examples for 2021-06-01 and 2021-06-01-preview and data-residency aware resources
|
Hi, @sameerpatro 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 |
|---|---|
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.DataBoxEdge/stable/2021-06-01/databoxedge.json#L3049 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.DataBoxEdge/stable/2021-06-01/databoxedge.json#L3295 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.DataBoxEdge/preview/2021-06-01-preview/databoxedge.json#L3049 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.DataBoxEdge/preview/2021-06-01-preview/databoxedge.json#L3295 |
| Per the Noun_Verb convention for Operation Ids, the noun 'SupportPackages' 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/2021-06-01/databoxedge.json#L3612 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'SupportPackages' 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/preview/2021-06-01-preview/databoxedge.json#L3612 |
|
| 'PUT' operation 'DiagnosticSettings_UpdateDiagnosticProactiveLogCollectionSettings' should use method name 'Create'. 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/2021-06-01/databoxedge.json#L767 |
|
| 'PUT' operation 'DiagnosticSettings_UpdateDiagnosticRemoteSupportSettings' should use method name 'Create'. 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/2021-06-01/databoxedge.json#L870 |
|
| 'PUT' operation 'DiagnosticSettings_UpdateDiagnosticProactiveLogCollectionSettings' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DataBoxEdge/preview/2021-06-01-preview/databoxedge.json#L767 |
|
| 'PUT' operation 'DiagnosticSettings_UpdateDiagnosticRemoteSupportSettings' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DataBoxEdge/preview/2021-06-01-preview/databoxedge.json#L870 |
|
| The child tracked resource, 'jobs' with immediate parent 'DataBoxEdgeDevice', must have a list by immediate parent operation. Location: Microsoft.DataBoxEdge/stable/2021-06-01/databoxedge.json#L6032 |
|
| The child tracked resource, 'operationsStatus' with immediate parent 'DataBoxEdgeDevice', must have a list by immediate parent operation. Location: Microsoft.DataBoxEdge/stable/2021-06-01/databoxedge.json#L6032 |
|
| The child tracked resource, 'jobs' with immediate parent 'DataBoxEdgeDevice', must have a list by immediate parent operation. Location: Microsoft.DataBoxEdge/preview/2021-06-01-preview/databoxedge.json#L6032 |
|
| The child tracked resource, 'operationsStatus' with immediate parent 'DataBoxEdgeDevice', must have a list by immediate parent operation. Location: Microsoft.DataBoxEdge/preview/2021-06-01-preview/databoxedge.json#L6032 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: toBeExportedForShoebox Location: Microsoft.DataBoxEdge/stable/2021-06-01/databoxedge.json#L6696 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: fillGapWithZero Location: Microsoft.DataBoxEdge/stable/2021-06-01/databoxedge.json#L6761 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.DataBoxEdge/stable/2021-06-01/databoxedge.json#L7241 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: toBeExportedForShoebox Location: Microsoft.DataBoxEdge/preview/2021-06-01-preview/databoxedge.json#L6696 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: fillGapWithZero Location: Microsoft.DataBoxEdge/preview/2021-06-01-preview/databoxedge.json#L6761 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.DataBoxEdge/preview/2021-06-01-preview/databoxedge.json#L7241 |
|
| The resource 'Node' does not have get operation, please add it. Location: Microsoft.DataBoxEdge/stable/2021-06-01/databoxedge.json#L7111 |
|
| The resource 'Node' does not have get operation, please add it. Location: Microsoft.DataBoxEdge/preview/2021-06-01-preview/databoxedge.json#L7111 |
|
| 'SubscriptionProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBoxEdge/stable/2021-06-01/databoxedge.json#L8450 |
|
| 'SubscriptionRegisteredFeatures' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBoxEdge/stable/2021-06-01/databoxedge.json#L8474 |
|
| 'state' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBoxEdge/stable/2021-06-01/databoxedge.json#L5565 |
|
| 'registrationDate' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBoxEdge/stable/2021-06-01/databoxedge.json#L5579 |
|
| 'subscriptionId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBoxEdge/stable/2021-06-01/databoxedge.json#L5582 |
|
| 'tenantId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBoxEdge/stable/2021-06-01/databoxedge.json#L8453 |
|
| 'locationPlacementId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBoxEdge/stable/2021-06-01/databoxedge.json#L8456 |
|
| 'quotaId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBoxEdge/stable/2021-06-01/databoxedge.json#L8459 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️Cross-Version Breaking Changes: 160 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.9.0)
- current:preview/2021-06-01-preview/databoxedge.json compared with base:stable/2021-02-01/databoxedge.json
- current:preview/2021-06-01-preview/databoxedge.json compared with base:preview/2021-02-01-preview/databoxedge.json
- current:stable/2021-06-01/databoxedge.json compared with base:stable/2021-02-01/databoxedge.json
- current:stable/2021-06-01/databoxedge.json compared with base:preview/2021-02-01-preview/databoxedge.json
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
|
Hi @sameerpatro, Your PR has some issues. Please fix the CI sequentially by following the order of
|
…ttps://github.com/sameerpatro/azure-rest-api-specs into sameerpatro/swagger-ase-2021-06-01-stable-preview
Update DataBoxEdgeDeviceGetByNameWithDataResidency.json
…ttps://github.com/sameerpatro/azure-rest-api-specs into sameerpatro/swagger-ase-2021-06-01-stable-preview
Update databoxedge.json
Update databoxedge.json
|
Hi @chunyu3 , We need help with the violation. It would be great if you could help us on the above to proceed with the PR merge. Thanks. |
|
Hi, @sameerpatro your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
|
/azp run |
|
Commenter does not have sufficient privileges for PR 15929 in repo Azure/azure-rest-api-specs |
...taboxedge/resource-manager/Microsoft.DataBoxEdge/preview/2021-06-01-preview/databoxedge.json
Show resolved
Hide resolved
|
@sameerpatro Can you please follow the instruction for Adding a new API version This allows the reviewer to compare just two commits to see changes introduced by the new api version and makes the review more efficient. Or please let us know if there are commits we can compare to see new changes only, then we can proceed the review. |
|
Hi @j5lim , |
I'm not talking about the number of commits. The number of commits does not matter as long as the reviewer can compare two commits to see new changes only. I see databoxedge.json exists in the previous api-version. So the PR does not seem to contain new changes only. |
|
Thanks. It is a new API version over 2021-02-01. Will you be able to compare between 1) 2021-02-01 and 2021-06-01 2) 2021-06-01 and 2021-06-01-preview and sign off? Is the change you are asking a new requirement? We used to follow same process as we did now for reviewing previous versions |
Given the amount of files, it will be very inefficient for the reviewer to compare multiple api-versions manually. Can you please create a new PR following Thank you. |
Thanks @sameerpatro. Tagging the current weeks' reviewers @chiragg4u @raosuhas so that they can review. |
|
Hi @chiragg4u @raosuhas, |
|
@chiragg4u / @raosuhas , Can you please help to let me know if you have any update on this? Can you please help to review it. We want to close on this soon. Thanks for help. |
|
I am closing this as I have created another PR #16120. Thanks. |
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:
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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
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.