-
Notifications
You must be signed in to change notification settings - Fork 5.3k
datafactory: making the References actual Discriminated Types rather than documenting around it #23013
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
base: main
Are you sure you want to change the base?
datafactory: making the References actual Discriminated Types rather than documenting around it #23013
Conversation
…than documenting around it
Hi @tombuildsstuff, 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
|
Rule | Message |
---|---|
Runtime Exception |
"new":"https://github.com/Azure/azure-rest-api-specs/blob/afdb5bca2b32b05451e1f1c4d5fc6a399a9b320b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json", "details":"incompatible properties : properties\n definitions/ManagedIdentityCredentialResource/properties/properties\n at file:///mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L7683:8\n definitions/CredentialResource/properties/properties\n at file:///mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L7983:8" |
️️✔️
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 specs (v2.2.2) | new version | base version |
---|---|---|
package-2018-06 | package-2018-06(afdb5bc) | 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 |
---|---|
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.DataFactory/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L56 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L57 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L352 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:type. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L437 |
GetResponseCodes |
GET operation must have response codes 200 and default. In addition, can have 202 if the GET represents the location header polling url. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L457 |
NoErrorCodeResponses |
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L496 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L696 |
GetResponseCodes |
GET operation must have response codes 200 and default. In addition, can have 202 if the GET represents the location header polling url. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L755 |
NoErrorCodeResponses |
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L797 |
ConsistentPatchProperties |
The property 'autoUpdate' in the request body either not apppear in the resource model or has the wrong level. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L840 |
ConsistentPatchProperties |
The property 'updateDelayOffset' in the request body either not apppear in the resource model or has the wrong level. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L840 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L950 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L981 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L1175 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L1181 |
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L1188 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L1221 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L1227 |
OperationIdNounVerb |
Per the Noun_Verb convention for Operation Ids, the noun 'IntegrationRuntimes' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L1418 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L1504 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L1510 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L1813 |
GetResponseCodes |
GET operation must have response codes 200 and default. In addition, can have 202 if the GET represents the location header polling url. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L1875 |
NoErrorCodeResponses |
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L1917 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L2018 |
GetResponseCodes |
GET operation must have response codes 200 and default. In addition, can have 202 if the GET represents the location header polling url. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L2080 |
NoErrorCodeResponses |
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L2122 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L2223 |
GetResponseCodes |
GET operation must have response codes 200 and default. In addition, can have 202 if the GET represents the location header polling url. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L2285 |
NoErrorCodeResponses |
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L2327 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌
SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️❌
ModelValidation: 83 Errors, 0 Warnings failed [Detail]
Only 30 items are listed, please refer to log for more details.
️️✔️
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]
Hi, @tombuildsstuff 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 Generation Artifacts
|
Thank you for your contribution tombuildsstuff! We will review the pull request and get back to you soon. |
Generated ApiView
|
Hi @tombuildsstuff, 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. |
Hi @tombuildsstuff, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This PR is now pending on the ADF service team's review. @wuxu92 considering you are a member of Azure organization, could you contact those persons internally to speed things up? |
Any update here @ArcturusZhang @wuxu92 @rkmanda @AzureRestAPISpecReview? |
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.
This should be extended to cover PipelineReference, DatasetReference, etc. as well.
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Please address or respond to feedback from the ARM API reviewer. |
@Frey-Wang updated |
@Frey-Wang could you take another look? |
These two types being defined with the same constant name causes flapping on our side where the constant is pulled out with differing values: https://github.com/hashicorp/pandora/pull/2210/files#diff-39360c196a766e2866c7638d98b4bd115acaf568d065d9763a2c3f4d74440d5dL9-R10
Since there's a
type
field these are discriminated types and should be annotated as such, so this PR makes that change which fixes this issue.