DataBoxEdge Swagger API Review- 2021-02-01 #14921
Merged
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, @arjoojain2812 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 '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-02-01/databoxedge.json#L3600 |
|
| '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-02-01/databoxedge.json#L761 |
|
| '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-02-01/databoxedge.json#L861 |
|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'DiagnosticSettings_UpdateDiagnosticProactiveLogCollectionSettings' Request Model: 'DiagnosticProactiveLogCollectionSettings' Response Model: '' Location: Microsoft.DataBoxEdge/stable/2021-02-01/databoxedge.json#L756 |
|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'DiagnosticSettings_UpdateDiagnosticRemoteSupportSettings' Request Model: 'DiagnosticRemoteSupportSettings' Response Model: '' Location: Microsoft.DataBoxEdge/stable/2021-02-01/databoxedge.json#L856 |
|
| 200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'DiagnosticSettings_UpdateDiagnosticProactiveLogCollectionSettings', Response code: '200' Location: Microsoft.DataBoxEdge/stable/2021-02-01/databoxedge.json#L790 |
|
| 200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'DiagnosticSettings_UpdateDiagnosticRemoteSupportSettings', Response code: '200' Location: Microsoft.DataBoxEdge/stable/2021-02-01/databoxedge.json#L893 |
|
| 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-02-01/databoxedge.json#L7229 |
|
| '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-02-01/databoxedge.json#L5553 |
|
| '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-02-01/databoxedge.json#L5567 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.DataBoxEdge/stable/2021-02-01/databoxedge.json#L3037 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.DataBoxEdge/stable/2021-02-01/databoxedge.json#L3283 |
| The child tracked resource, 'jobs' with immediate parent 'DataBoxEdgeDevice', must have a list by immediate parent operation. Location: Microsoft.DataBoxEdge/stable/2021-02-01/databoxedge.json#L6020 |
|
| The child tracked resource, 'operationsStatus' with immediate parent 'DataBoxEdgeDevice', must have a list by immediate parent operation. Location: Microsoft.DataBoxEdge/stable/2021-02-01/databoxedge.json#L6020 |
|
| 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-02-01/databoxedge.json#L6684 |
|
| 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-02-01/databoxedge.json#L6749 |
|
| The resource 'Node' does not have get operation, please add it. Location: Microsoft.DataBoxEdge/stable/2021-02-01/databoxedge.json#L7099 |
️️✔️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: 13 Errors, 153 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.11)
- current:stable/2021-02-01/databoxedge.json compared with base:stable/2020-12-01/databoxedge.json
- current:stable/2021-02-01/databoxedge.json compared with base:preview/2021-02-01-preview/databoxedge.json
Only 10 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with latest preview version:
Only 10 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️[Staging] SDK Track2 Validation: 24 Warnings warning [Detail]
- The following tags are being changed in this PR
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2021-02-01", "details":"Schema 'ArcAddon' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from ArcAddon" |
|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2021-02-01", "details":"Schema 'ArcAddon' has a property 'name' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from ArcAddon" |
|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2021-02-01", "details":"Schema 'ArcAddon' has a property 'type' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from ArcAddon" |
|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2021-02-01", "details":"Schema 'CloudEdgeManagementRole' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from CloudEdgeManagementRole" |
|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2021-02-01", "details":"Schema 'CloudEdgeManagementRole' has a property 'name' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from CloudEdgeManagementRole" |
|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2021-02-01", "details":"Schema 'CloudEdgeManagementRole' has a property 'type' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from CloudEdgeManagementRole" |
|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2021-02-01", "details":"Schema 'FileEventTrigger' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from FileEventTrigger" |
|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2021-02-01", "details":"Schema 'FileEventTrigger' has a property 'name' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from FileEventTrigger" |
|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2021-02-01", "details":"Schema 'FileEventTrigger' has a property 'type' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from FileEventTrigger" |
|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2021-02-01", "details":"Schema 'IoTAddon' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from IoTAddon" |
️️✔️[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
|
lirenhe
added
the
Reviewed-ChangesRequested
|
@arjoojain2812 Could you first fix the tool check errors? |
arjoojain2812
requested review from
00Kai0,
ArcturusZhang,
jsntcy,
msyyc and
RAY-316
as code owners
This was referenced Jun 23, 2021
@arjoojain2812, You should model it as an array. Portal can split by ',' and convert to array. |
added 2 commits
June 29, 2021 08:33
Refer best practice 'Inconsistent or incomplete CRUD' in https://armwiki.azurewebsites.net/rp_onboarding/process/api_review_best_practices.html In reply to: 868786924 Refers to: specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/databoxedge.json:711 in 4112bdb. [](commit_id = 4112bdb, deletion_comment = False) |
Hi Ramya, Have created a task for this, we will take it in the future release: https://msazure.visualstudio.com/DefaultCollection/One/_workitems/edit/10262489 |
Hi Ramya, As we discussed, we can take this up in future releases, it would need discussion with different teams. |
Ramya, have added a work-item for this: https://msazure.visualstudio.com/DefaultCollection/One/_workitems/edit/9729045 currently we have the status code 202 for all the PUT APIs, would discuss it internally and will update it |
|
LGTM. Adding 'ARMSignedOff' label. |
RamyasreeChakka
approved these changes
Jun 30, 2021
RamyasreeChakka
added
ARMSignedOff
|
lirenhe
reviewed
Jul 7, 2021
added 2 commits
July 12, 2021 09:44
lirenhe
removed
the
Reviewed-ChangesRequested
lirenhe
approved these changes
Jul 12, 2021
This was referenced Jul 12, 2021
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* Initial Commit with previously reviewed Changes * Updated Swagger * Added Example files * Updated Description for the APIs which are in private preview * Updated ReadmeFiles * Fixed folder structure * fixed json example references * Fixed supportPackage and Proactivelogcollection jsons * Fixed Prettier check * Fixed Prettier check * Fixed Azure-auth * Fixing UpdateDiagnosticRemoteSupportSettings.json Go Validations * Fixed Model Validation * Fix Model Validation + Prettier Check * Fixed Model Validation * Swagger LinterValidation Fix * Removed Type from UpdateDiagnosticProactiveLogCollectionSettings.json, failing Model Validation * Updated all the example files * fixed comments * Updated corresponding examples * Fixed Validation * Updated the tag to the latest * Fixed the tag Co-authored-by: Arzoo Jain <[email protected]>
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with 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
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from 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.