-
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
Added missing APIs in Synapse Swagger. #12424
Added missing APIs in Synapse Swagger. #12424
Conversation
Hi, @amoghnatu 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
Only 10 items are listed, please refer to log for more details.
|
Rule | Message |
---|---|
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: 'SqlPoolMaintenanceWindows_CreateOrUpdate' Request Model: 'MaintenanceWindows' Response Model: '' New: Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json#L1235 |
|
The summary and description values should not be same. New: Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json#L1176 |
|
The summary and description values should not be same. New: Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json#L1235 |
|
200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'SqlPoolMaintenanceWindows_CreateOrUpdate', Response code: '200' New: Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json#L1280 |
|
Guid used in model definition 'WorkspaceRepositoryConfiguration' for property 'tenantId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. New: Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#L1089 |
|
'parameters' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. New: Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json#L1902 |
|
'parameters' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. New: Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json#L2027 |
|
'timeRanges' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json#L5866 |
|
'rank' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json#L6286 |
|
'op' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json#L7396 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
Swagger Generation Artifacts
|
Rule | Message |
---|---|
RestBuild error |
"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=188094&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"FATAL ERROR: CALL_AND_RETRY_LAST Allocation failed - JavaScript heap out of memory" |
NewApiVersionRequired reason: |
Hi @amoghnatu, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
Hi, @amoghnatu your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @qianwens |
Hi @amoghnatu, Your PR has some issues. Please fix the CI sequentially by following the order of
|
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
The breaking changes in Go SDK are expected since we are removing that property in this PR. |
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.
Approving from ARM side.
@@ -5380,6 +5561,122 @@ | |||
}, | |||
"description": "Represents the response to a List Sql pool replication link request." | |||
}, | |||
"MaintenanceWindowOptionsProperties": { |
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.
Annotate Read-only properties with readOnly: true
https://armwiki.azurewebsites.net/api_contracts/guidelines/openapi.html#oapi019-annotate-read-only-properties-with-readonly-true
* Added missing APIs in Synapse Swagger. * Fixed spell check error * Swagger correctness changes. * Fixed prettier issues * Minor correctness error fixes. * Fixed prettier check * fixed lint errors * Fixed some more missing APIs. * Added newly reported Missing API Co-authored-by: Amogh Natu <[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
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 API 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.