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.

Sign up for GitHub

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

Users/yogms/copilot api spec dataplane review #33052

Open
wants to merge 18 commits into
base: main
Choose a base branch
from

Removed unused imports

f52772b
Select commit
Loading
Failed to load commit list.
Open

Users/yogms/copilot api spec dataplane review #33052

Removed unused imports
f52772b
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Mar 7, 2025 in 3m 54s

Swagger LintDiff succeeded

LintDiff
View Azure DevOps build log for more details.

Details

Compared specs (v2.2.3) new version base version
package-2025-03-01 package-2025-03-01(f52772b) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L163
⚠️ OperationId OperationId for put method should contain both 'Create' and 'Update'
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L198
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L204
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L278
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L318
⚠️ Post201Response Using post for a create operation is discouraged.
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L424
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L424
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L462
⚠️ OperationId OperationId for patch method should contain both 'Create' and 'Update'
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L497
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L506
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L562
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L595
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L602
⚠️ Post201Response Using post for a create operation is discouraged.
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L664
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L664
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L706
⚠️ DefaultResponse Operation is missing a default response.
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L707
⚠️ 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: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L730
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L831
⚠️ OperationId OperationId for put method should contain both 'Create' and 'Update'
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L866
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L872
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L946
⚠️ LongRunningOperationsOptionsValidator A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled.
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L1011		 RPC-Async-V1-05
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L1019
⚠️ PageableOperation Based on the response model schema, operation 'OperationProgress_GetOperationResult' might be pageable. Consider adding the x-ms-pageable extension.
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L1097
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L1097
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L1104
⚠️ 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: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L1172
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L1293
⚠️ 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: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L1378
⚠️ 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: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L1407
⚠️ 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: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L1413
⚠️ 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: Microsoft.Industries.ManufacturingDataSolution.Copilot/stable/2025-03-01/openapi.json#L2337
View more details on openapi-pipeline-app