-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
[Microsoft.StorageSync] Update 2020-03-01 and 2020-09-01 specifications to address swagger correctness and completeness items. #16041
Conversation
…rious properties that are returned by RP but not defined in swagger.
Hi, @anpint 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. vsswagger@microsoft.com |
[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 |
---|---|
'GET' operation 'LocationOperationStatus' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L3102 |
|
'GET' operation 'LocationOperationStatus' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L3102 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Workflows_Get Location: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L3104 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Workflows_Get Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L3104 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R4009 - RequiredReadOnlySystemData |
The response of operation:'StorageSyncServices_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L199 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L560 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'SyncGroups_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L940 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'CloudEndpoints_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L1167 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ServerEndpoints_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L2124 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'RegisteredServers_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L2501 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Workflows_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L2882 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'StorageSyncServices_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L120 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'PrivateEndpointConnections_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L603 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'SyncGroups_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L870 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'CloudEndpoints_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L1064 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ServerEndpoints_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L1927 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'RegisteredServers_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L2562 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'StorageSyncServices_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L253 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ServerEndpoints_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L2026 |
R4010 - RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L109 |
R4010 - RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L549 |
R4010 - RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L109 |
R4010 - RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L549 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L2235 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L2235 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L3475 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L3482 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L3958 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L4127 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L4248 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L4380 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L4386 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L4418 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L4424 |
️️✔️
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 succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
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).
Hi, @anpint your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Swagger Generation Artifacts
|
Hi @anpint, Your PR has some issues. Please fix the CI sequentially by following the order of
|
NewApiVersionRequired reason: |
Filed work item for breaking change review: Scenario 10931913: Breaking change review for Microsoft.StorageSync, API Versions 2020-03-01 and 2020-09-01 |
@anpint, as your PR contains breaking changes, could you follow http://aka.ms/bcforapi to get it reviewed? |
Thanks @lirenhe we just went through a review of the breaking changes and it was approved. Please let me know if anything else is needed to merge the PR |
As the PR add some new APIs, could you also work with ARM team to get their approval? I added the label of 'WaitForArmFeedback' but you could reach them directly for the review. |
@@ -3071,6 +3071,66 @@ | |||
} | |||
} | |||
} | |||
}, | |||
"/subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/locations/{locationName}/operations/{operationId}": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@anpint
Your spec defines operations API as /subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/locations/{locationName}/operations/{operationId}
But the examples use operationResults in the ID. Which one is correct?
Can you point me to your S360 error?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As per our offline discussion I understand the resource name 'operations' is correct and is what your shipped API is using for Azure-AsyncOperation format. The resourceName should be 'operationStatuses'. Refer https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#azure-asyncoperation-resource-format
The resource name 'operations' confuses with RP general operations API. Please add a work item to fix the resource name in future API versions.
I am signing off now as this is an existing API and you are trying to fix S360 error.
@lirenhe We've completed the ARM review as well. Please go ahead and merge this PR for us unless there's anything else we need to do. Thanks. |
…ns to address swagger correctness and completeness items. (Azure#16041) * Address swagger correctness items in 2020-03-01 API version. Added various properties that are returned by RP but not defined in swagger. * Swagger completeness: Add location based async operation polling * Fix reference to example file for 2020-09-01 * Fix semantic validation error for 2020-09-01 and fix a typo in 2020-03-01 * Fix typo in examples for location based operations API
…ns to address swagger correctness and completeness items. (Azure#16041) * Address swagger correctness items in 2020-03-01 API version. Added various properties that are returned by RP but not defined in swagger. * Swagger completeness: Add location based async operation polling * Fix reference to example file for 2020-09-01 * Fix semantic validation error for 2020-09-01 and fix a typo in 2020-03-01 * Fix typo in examples for location based operations API
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:
No service changes are needed for these specification changes.
Swagger will be publish once the fixes are signed off and the PR is completed.
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.
-[x] 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.