-
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
fix swagger definition. #26846
fix swagger definition. #26846
Conversation
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Hi @wangbwn, this service has enabled Service API Toolset. All spec updates MUST be initiated from service ADO project repo, so that to guarantee it to be the source of truth., please review this pull request if it's intentional or reject it if it's not expected. Normally, all the specification or example changes should start with PR created in ADO. |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
Dataset.json | 2018-06-01(f85dddf) | 2018-06-01(main) |
IntegrationRuntime.json | 2018-06-01(f85dddf) | 2018-06-01(main) |
LinkedService.json | 2018-06-01(f85dddf) | 2018-06-01(main) |
Pipeline.json | 2018-06-01(f85dddf) | 2018-06-01(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.6) | new version | base version |
---|---|---|
package-2018-06 | package-2018-06(f85dddf) | package-2018-06(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
Consider using x-ms-client-flatten to provide a better end user experience Location: stable/2018-06-01/entityTypes/Dataset.json#L61 |
|
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: stable/2018-06-01/entityTypes/Dataset.json#L614 |
|
Schema should have a description or title. Location: stable/2018-06-01/entityTypes/Dataset.json#L633 |
|
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: stable/2018-06-01/entityTypes/Dataset.json#L667 |
|
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: stable/2018-06-01/entityTypes/Dataset.json#L725 |
|
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: stable/2018-06-01/entityTypes/Dataset.json#L759 |
|
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: stable/2018-06-01/entityTypes/Dataset.json#L853 |
|
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: stable/2018-06-01/entityTypes/Dataset.json#L891 |
|
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: stable/2018-06-01/entityTypes/Dataset.json#L934 |
|
Schema should have a description or title. Location: stable/2018-06-01/entityTypes/Dataset.json#L948 |
|
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: stable/2018-06-01/entityTypes/Dataset.json#L982 |
|
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L104 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L169 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L652 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L1131 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L1292 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L1341 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L1646 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L1650 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L1670 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L1701 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: stable/2018-06-01/entityTypes/Pipeline.json#L68 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: stable/2018-06-01/entityTypes/Pipeline.json#L273 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: stable/2018-06-01/entityTypes/Pipeline.json#L277 |
|
Schema should have a description or title. Location: stable/2018-06-01/entityTypes/Pipeline.json#L3188 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: stable/2018-06-01/entityTypes/Pipeline.json#L6479 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: stable/2018-06-01/entityTypes/Pipeline.json#L6766 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: stable/2018-06-01/entityTypes/Pipeline.json#L6786 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: stable/2018-06-01/entityTypes/Pipeline.json#L7022 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: stable/2018-06-01/entityTypes/Pipeline.json#L7031 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
...tafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json
Show resolved
Hide resolved
...cation/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json
Outdated
Show resolved
Hide resolved
...atafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json
Outdated
Show resolved
Hide resolved
The Snowflake linkedService requires an update to the connectionString property to include 'x-ms-format'. Could you please confirm this? Additionally, it seems that the PR may not cover all instances of incorrect 'x-ms-format' properties listed in excel. Could you verify? |
From the adf it should look like dfe-string. |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1
Breaking changes review (Diagram Step 1)
If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2
ARM API changes review (Diagram Step 2)
ARMReview
label.Click here to see the diagram footnotes
Diagram footnotes
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting help
section below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the Diagram Step 2, "ARM API changes Review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiView
comment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.
queued
state, please add a comment with contents/azp run
.This should result in a new comment denoting a
PR validation pipeline
has started and the checks should be updated after few minutes.