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

Jump to bottom

Fix bug in swagger #31070

Merged
merged 1 commit into from
Oct 18, 2024

Fix bug in swagger

ee4dd7a
Select commit
Loading
Failed to load commit list.
Merged

Fix bug in swagger #31070

Fix bug in swagger
ee4dd7a
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Oct 16, 2024 in 9m 18s

Swagger LintDiff succeeded

LintDiff
View Azure DevOps build log for more details.

Details

Compared specs (v2.2.3) new version base version
package-preview-2024-10 package-preview-2024-10(ee4dd7a) package-preview-2024-10(release-machinelearningservices-Microsoft.MachineLearningServices-2024-10-01-preview)

The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.

Rule Message
❌ SecurityDefinitionsStructure Every OpenAPI(swagger) spec/configuration must have a security definitions section and it must adhere to the following structure: https://github.com/Azure/azure-openapi-validator/blob/main/docs/security-definitions-structure-validation.md
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L1
❌ DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L162
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L252
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:type.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L299
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:keyVaultProperties.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L299
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:keyIdentifier.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L299
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:name.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L299
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L307
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L311
❌ ProvisioningStateSpecifiedForLROPut 201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L328
❌ 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.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L328
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L366
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:authType.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L588
❌ 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.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L613
❌ ProvisioningStateSpecifiedForLROPut 200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L1190
❌ ProvisioningStateSpecifiedForLROPut 201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L1190
❌ ParametersSchemaAsTypeObject The schema for body parameters must specify type:object and include a definition for its reference model.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L1300
❌ PostResponseCodes Long-running POST operations must have responses with 202 and default return codes. They must also 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. They also must not have other response codes.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L1349
❌ ProvisioningStateSpecifiedForLROPut 200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L1606
❌ ProvisioningStateSpecifiedForLROPut 201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L1606
❌ ProvisioningStateSpecifiedForLROPut 200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L1854
❌ ProvisioningStateSpecifiedForLROPut 201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L1854
❌ ProvisioningStateSpecifiedForLROPut 201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L2253
❌ 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.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L2253
❌ ProvisioningStateSpecifiedForLROPut 201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L2498
❌ 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.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L2498
❌ ProvisioningStateSpecifiedForLROPut 200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L2848
❌ ProvisioningStateSpecifiedForLROPut 201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L2848
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L3207
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L3233
❌ DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L3300
❌ ProvisioningStateSpecifiedForLROPut 200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L3410
❌ ProvisioningStateSpecifiedForLROPut 201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L3410
❌ 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.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L3410
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L3577
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L3674
❌ 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.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L3691
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L3732
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L3777
❌ 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.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L3873
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L4319
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L4380
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L4385
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L4390
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L4395
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L4400
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L4405
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L4410
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L4415
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-10-01-preview/workspaceRP.json#L4420
View more details on openapi-pipeline-app