Add version 2023-10-01-preview for Purview.Workflow #25893
Merged
openapi-pipeline-app / Swagger LintDiff
succeeded
Oct 10, 2023 in 3m 9s
Swagger LintDiff succeeded
LintDiff
View more details.
Details
compared tags (via openapi-validator v2.1.6) | new version | base version |
---|---|---|
package-2023-10-01-preview | package-2023-10-01-preview(d9cab54) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WorkflowModel'. Consider using the plural form of 'Workflow' 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: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L89 |
||
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: 'Workflow_CreateOrReplace' Request Model: 'parameters[1].schema' Response Model: 'responses[200].schema' Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L118 |
||
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WorkflowModel'. Consider using the plural form of 'Workflow' 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: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L123 |
||
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WorkflowModel'. Consider using the plural form of 'Workflow' 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: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L166 |
||
Since operation response has model definition in array type, it should be of the form '_list'. Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L194 |
||
Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L194 |
||
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WorkflowModel'. Consider using the plural form of 'Workflow' 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: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L199 |
||
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L206 |
||
Error response should contain a x-ms-error-code header. Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L229 |
||
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WorkflowRunModel'. Consider using the plural form of 'WorkflowRun' 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: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L360 |
||
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WorkflowRunModel'. Consider using the plural form of 'WorkflowRun' 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: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L396 |
||
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WorkflowTaskModel'. Consider using the plural form of 'WorkflowTask' 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: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L519 |
||
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ApprovalModel'. Consider using the plural form of 'Approval' 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: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L552 |
||
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ApprovalModel'. Consider using the plural form of 'Approval' 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: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L594 |
||
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WorkflowTaskModel'. Consider using the plural form of 'WorkflowTask' 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: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L636 |
||
Schema should have a description or title. Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L1228 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L1259 |
The following errors/warnings exist before current PR submission:
Loading