Skip to content
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

Add version 2023-10-01-preview for Purview.Workflow #25893

Merged
merged 8 commits into from
Oct 11, 2023

Add description about max page size

d9cab54
Select commit
Loading
Failed to load commit list.
Merged

Add version 2023-10-01-preview for Purview.Workflow #25893

Add description about max page size
d9cab54
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Oct 10, 2023 in 3m 9s

Swagger LintDiff succeeded

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]
⚠️ OperationIdNounConflictingModelNames 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
⚠️ PutRequestResponseScheme 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
⚠️ OperationIdNounConflictingModelNames 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
⚠️ OperationIdNounConflictingModelNames 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
⚠️ ListInOperationName 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
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L194
⚠️ OperationIdNounConflictingModelNames 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
⚠️ PathParameterSchema 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
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L229
⚠️ OperationIdNounConflictingModelNames 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
⚠️ OperationIdNounConflictingModelNames 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
⚠️ OperationIdNounConflictingModelNames 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
⚠️ OperationIdNounConflictingModelNames 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
⚠️ OperationIdNounConflictingModelNames 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
⚠️ OperationIdNounConflictingModelNames 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
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L1228
⚠️ AvoidNestedProperties 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:

Rule Message
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L74
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L96
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L110
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L130
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L153
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L173
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L184
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L271
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L345
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L370
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L381
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L406
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L420
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L423
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L504
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L525
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L526
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L537
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L559
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L576
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L579
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L601
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L618
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L621
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L643
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L660
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L663
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L685
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L702
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L705
⚠️ EnumInsteadOfBoolean 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: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L770
⚠️ PropertyDescription Property should have a description.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L798
⚠️ EnumInsteadOfBoolean 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: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L841
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L881
⚠️ PropertyDescription Property should have a description.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L943
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L1003
⚠️ AvoidNestedProperties 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#L1131
⚠️ PropertyDescription Property should have a description.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L1191
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L1200
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L1209
⚠️ AvoidNestedProperties 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#L1344
⚠️ AvoidNestedProperties 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#L1368
⚠️ AvoidNestedProperties 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#L1387
⚠️ PropertyDescription Property should have a description.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L1387
⚠️ PropertyDescription Property should have a description.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L1394
⚠️ PropertyDescription Property should have a description.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L1635
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L1653
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L1691