[Synapse]add new apis of Pause/Resume for Synapse Link #21240
Merged
Conversation
This file contains hidden or 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, @ZhichengYang-MS 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
|
| compared swaggers (via Oad v0.10.2)] | new version | base version |
|---|---|---|
| linkConnections.json | 2022-12-01-preview(b1df23e) | 2022-08-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 92 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-artifacts-composite-v6 | package-artifacts-composite-v6(b1df23e) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 30 items are listed, please refer to log for more details.
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L6 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'LinkConnectionModel'. Consider using the plural form of 'LinkConnection' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L34 |
||
| Error response should contain a x-ms-error-code header. Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L48 |
||
Error response schema should contain an object property named error.Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L50 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'LinkConnectionModel'. Consider using the plural form of 'LinkConnection' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L70 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L73 |
||
| Error response should contain a x-ms-error-code header. Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L96 |
||
Error response schema should contain an object property named error.Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L98 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'LinkConnectionModel'. Consider using the plural form of 'LinkConnection' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L113 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L116 |
||
| Error response should contain a x-ms-error-code header. Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L130 |
||
Error response schema should contain an object property named error.Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L132 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'LinkConnectionModel'. Consider using the plural form of 'LinkConnection' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L147 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L150 |
||
| All success responses except 202 & 204 should define a response body. Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L158 |
||
| Error response should contain a x-ms-error-code header. Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L164 |
||
Error response schema should contain an object property named error.Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L166 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'LinkConnectionModel'. Consider using the plural form of 'LinkConnection' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L183 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L186 |
||
| All success responses except 202 & 204 should define a response body. Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L203 |
||
| Error response should contain a x-ms-error-code header. Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L206 |
||
Error response schema should contain an object property named error.Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L208 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'LinkConnectionModel'. Consider using the plural form of 'LinkConnection' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L225 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L228 |
||
| All success responses except 202 & 204 should define a response body. Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L236 |
||
| Error response should contain a x-ms-error-code header. Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L239 |
||
Error response schema should contain an object property named error.Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L241 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'LinkConnectionModel'. Consider using the plural form of 'LinkConnection' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L258 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L261 |
||
| All success responses except 202 & 204 should define a response body. Location: Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json#L269 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️❌~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
ghost
added
the
|
Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @ZhichengYang-MS, 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. |
ZhichengYang-MS
force-pushed
the
dev/zhichengyang/synapselink-add-pause-resume-apis
branch
from
201f695 to
a78bcde
Compare
ZhichengYang-MS
force-pushed
the
dev/zhichengyang/synapselink-add-pause-resume-apis
branch
from
a78bcde to
132a6e7
Compare
AzureRestAPISpecReview
added
CI-FixRequiredOnFailure
and removed
BreakingChangeReviewRequired
|
Hi @ZhichengYang-MS, Your PR has some issues. Please fix the CI sequentially by following the order of
|
...ication/synapse/data-plane/Microsoft.Synapse/preview/2022-11-01-preview/linkConnections.json
Show resolved
Hide resolved
...ication/synapse/data-plane/Microsoft.Synapse/preview/2022-11-01-preview/linkConnections.json
Outdated
Show resolved
Hide resolved
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
ZhichengYang-MS
force-pushed
the
dev/zhichengyang/synapselink-add-pause-resume-apis
branch
from
44d0ace to
821fe18
Compare
AzureRestAPISpecReview
removed
the
BreakingChangeReviewRequired
...ication/synapse/data-plane/Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json
Outdated
Show resolved
Hide resolved
...ication/synapse/data-plane/Microsoft.Synapse/preview/2022-12-01-preview/linkConnections.json
Show resolved
Hide resolved
weidongxu-microsoft
approved these changes
Nov 22, 2022
weidongxu-microsoft
added
the
APIStewardshipBoard-SignedOff
anandanthony
pushed a commit
to anandMicro/azure-rest-api-specs
that referenced
this pull request
Dec 16, 2022
* add pause resume apis * fix examples * simplified changes * fix version * fix linDiff * remove location info in url
kayousef-zz
pushed a commit
to kayousef-zz/azure-rest-api-specs
that referenced
this pull request
Dec 21, 2022
* add pause resume apis * fix examples * simplified changes * fix version * fix linDiff * remove location info in url
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Data Plane API - Pull Request
Add new apis of Pause and Resume for Synapse Link
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous Open API document (swagger) if applicable, and the root paths that have been updated.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links
fix #21421