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

Update workspaceRP 2024-01-01-preview swagger #27194

Merged
merged 45 commits into from
Jan 30, 2024

Merge branch 'release-machinelearningservices-Microsoft.MachineLearni…

53783aa
Select commit
Loading
Failed to load commit list.
Merged

Update workspaceRP 2024-01-01-preview swagger #27194

Merge branch 'release-machinelearningservices-Microsoft.MachineLearni…
53783aa
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Jan 30, 2024 in 7m 26s

Swagger LintDiff succeeded

LintDiff
View Azure DevOps build log for more details.

Details

compared tags (via openapi-validator v2.1.6) new version base version
package-preview-2024-01 package-preview-2024-01(53783aa) package-preview-2024-01(release-machinelearningservices-Microsoft.MachineLearningServices-2024-01-01-preview)

[must fix]The following errors/warnings are introduced by current PR:
Only 50 items are listed, please refer to log for more details.

Rule Message Related RPC [For API reviewers]
⚠️ ParameterDescription Parameter should have a description.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L75
⚠️ ParameterDescription Parameter should have a description.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L131
⚠️ 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.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L431
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L797
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L808
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L811
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L817
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L836
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L936
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L939
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L945
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L964
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L990
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L993
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1002
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1015
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1039
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1042
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1051
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1087
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1114
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1117
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1126
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1139
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1165
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1168
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1180
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1204
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1229
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1232
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1244
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1257
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1281
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1284
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1296
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1332
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1359
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1362
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1371
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1384
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1396
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1407
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1410
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1419
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1432
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1461
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1464
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1473
⚠️ ParameterDescription Parameter should have a description.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1475
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1494


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-01-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-01-01-preview/workspaceRP.json#L162
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L252
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L307
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.MachineLearningServices/preview/2024-01-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-01-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-01-01-preview/workspaceRP.json#L328
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L366
❌ ParametersInPointGet Query parameter aoaiModelsToDeploy should be removed. Point Get's MUST not have query parameters other than api version.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L519
❌ 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-01-01-preview/workspaceRP.json#L616
❌ ParametersInPost aoaiModelsToDeploy is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L684
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1686
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L1712
❌ 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-01-01-preview/workspaceRP.json#L1779
❌ 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-01-01-preview/workspaceRP.json#L1889
❌ 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-01-01-preview/workspaceRP.json#L1889
❌ 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-01-01-preview/workspaceRP.json#L1889
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L2056
❌ ResourceNameRestriction The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L2077
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L2153
❌ 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-01-01-preview/workspaceRP.json#L2170
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L2211
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L2256
❌ 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-01-01-preview/workspaceRP.json#L2352
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L2846
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L2863
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L2919
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L2924
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L2929
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L2934
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L2939
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L2944
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L2949
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L2954
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L2959
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L2964
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L3109
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L3109
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L3109
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L3109
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L3109
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L3109
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L3109
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L3109
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L3109
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L3109
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L3624
❌ TrackedResourcePatchOperation Tracked resource 'PrivateEndpointConnection' must have patch operation that at least supports the update of tags.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L3951
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L4517
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L4766
View more details on openapi-pipeline-app