Added missing APIs in Synapse Swagger. #12424
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, @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. vsswagger@microsoft.com |
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 |
|---|---|
|
"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: |
This was referenced Jan 13, 2021
JeffreyRichter
approved these changes
Jan 14, 2021
JeffreyRichter
added
the
Approved-BreakingChange
|
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). |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @amoghnatu your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @qianwens |
|
Hi @amoghnatu, Your PR has some issues. Please fix the CI sequentially by following the order of
|
qianwens
approved these changes
Jan 15, 2021
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
|
/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. |
j5lim
approved these changes
Jan 15, 2021
| @@ -5380,6 +5561,122 @@ | |||
| }, | |||
| "description": "Represents the response to a List Sql pool replication link request." | |||
| }, | |||
| "MaintenanceWindowOptionsProperties": { | |||
There was a problem hiding this comment.
Annotate Read-only properties with readOnly: true
https://armwiki.azurewebsites.net/api_contracts/guidelines/openapi.html#oapi019-annotate-read-only-properties-with-readonly-true
j5lim
added
ARMSignedOff
This was referenced Jan 16, 2021
[ReleasePR synapse] [Synapse] - Remove x-ms-azure-resource
Azure/azure-resource-manager-schemas#1315
Merged
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* 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 <amnat@microsoft.com>
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 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.