-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
datafactory
: unique names for the enum type
for discriminated types
#28319
base: main
Are you sure you want to change the base?
Conversation
Hi @stephybun, this service has enabled ShiftLeft 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 is intentional or reject it if it is not expected. Normally, all the specification or example changes should start with PR created in ADO. |
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
Rule | Message |
---|---|
Runtime Exception |
"new":"https://github.com/Azure/azure-rest-api-specs/blob/f3243e200a6bba8dfbb29ab6710eeee80660abf1/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 " |
️️✔️
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.0) | new version | base version |
---|---|---|
package-2018-06 | package-2018-06(f3243e2) | 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]
Swagger Generation Artifacts
|
Generated ApiView
|
Thank you for your contribution stephybun! We will review the pull request and get back to you soon. |
], | ||
"x-ms-enum": { | ||
"name": "ExpressionType", | ||
"modelAsString": false |
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.
Please use modelAsString
: true, which could allow more values to add to this enum.
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.
Thanks, updated
Please address or respond to feedback from the ARM API reviewer. |
Does this PR conflict with #23013? It appears that both PRs address the same issue. |
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
The enum
type
for discriminated types has several differing definitions across the service. This PR gives the enumtype
for discriminated types a unique name.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.