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

Cognitive Services 2025-04-01 #32877

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Merge branch 'main' into user/zhili/CogSvc-2025-04-01-preview

acfea3b
Select commit
Loading
Failed to load commit list.
Draft

Cognitive Services 2025-04-01 #32877

Merge branch 'main' into user/zhili/CogSvc-2025-04-01-preview
acfea3b
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff failed Feb 27, 2025 in 4m 26s

Swagger LintDiff failed

LintDiff: 57 Errors, 485 Warnings
View Azure DevOps build log for more details.

Details

[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]
❌ 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.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3710		 RPC-Async-V1-11, RPC-Put-V1-11
❌ PatchResponseCodes 202 response for a LRO PATCH operation must not have a response schema specified.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3778		 RPC-Patch-V1-06
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:keySource.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3803		 RPC-Patch-V1-10
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:name.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3803		 RPC-Patch-V1-10
❌ 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.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3837		 RPC-Delete-V1-01
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:authType.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L4098		 RPC-Patch-V1-10
❌ 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.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L4123		 RPC-Async-V1-11, RPC-Put-V1-11
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:authType.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L4376		 RPC-Patch-V1-10
❌ 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.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L4401		 RPC-Async-V1-11, RPC-Put-V1-11
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L8089		 RPC-Policy-V1-05, RPC-Put-V1-23
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L8528		 RPC-Policy-V1-05, RPC-Put-V1-23
❌ GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L8562
❌ NestedResourcesMustHaveListOperation The nested resource 'CapabilityHostResource' does not have list operation, please add it.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L8626
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L8770		 RPC-Policy-V1-05, RPC-Put-V1-23
❌ AutoRest exception "tag":"package-preview-2025-04-01-preview",
"details":"Semantic violation: Path parameter 'projectName' referenced in path '/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/projects/projectName/capabilityHosts/capabilityHostName' needs to be defined in every operation at either the path or operation level. (Missing in 'delete',
'get',
'put') (paths > /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/projects/projectName/capabilityHosts/capabilityHostName) paramName: \u001b[32m'projectName'\u001b[39m uri: \u001b[32m'/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/projects/projectName/capabilityHosts/capabilityHostName'\u001b[39m methods: [ \u001b[32m'delete'\u001b[39m,
\u001b[32m'get'\u001b[39m,
\u001b[32m'put'\u001b[39m ]"
❌ AutoRest exception "tag":"package-preview-2025-04-01-preview",
"details":"Process() cancelled due to failure"
❌ AutoRest exception "tag":"package-preview-2025-04-01-preview",
"details":"!Error: Semantic validation failed. There was some errors"
❌ AutoRest exception "tag":"package-preview-2025-04-01-preview",
"details":"stack: Error: Semantic validation failed. There was some errors at /home/cloudtest/.autorest/@[email protected]/node_modules/@autorest/core/dist/src_lib_autorest-core_ts.js:5645:27 at runNextTicks (node:internal/process/task_queues:60:5) at processImmediate (node:internal/timers:447:9) at ScheduleNode (/home/cloudtest/.autorest/@[email protected]/node_modules/@autorest/core/dist/src_lib_autorest-core_ts.js:1351:29)"
❌ AutoRest exception "tag":"package-preview-2025-04-01-preview",
"details":"Autorest completed with an error. If you think the error message is unclear,
or is a bug,
please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing."
⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create Account
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3716
⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create Account Min
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3716
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3726
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3744
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3747
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3772
⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Update Account
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3784
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3791
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3809
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3812
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3831
⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Delete Account
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3843
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3850
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3859
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3862
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3878
⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Account
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3890
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3897
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3906
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3909
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3922
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3942
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3948
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3951
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3964
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3985
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3988
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3997
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L4010
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L4031
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L4034


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

Rule Message
❌ 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.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L31
❌ PatchResponseCodes 202 response for a LRO PATCH operation must not have a response schema specified.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L96
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:keySource.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L118
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:name.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L118
❌ 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.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L152
❌ PathForTrackedResourceTypes The path must be under a subscription and resource group for tracked resource types.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L237
❌ 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.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L281
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L584
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L612
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L671
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L1122
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L1150
❌ 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.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L1207
❌ 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.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L1207
❌ RequestSchemaForTrackedResourcesMustHaveTags A tracked resource MUST always have tags as a top level optional property. Tracked resource does not have tags in the request schema.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L1207
❌ 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.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L1266
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L1315
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L1343
❌ ResourceNameRestriction The resource name parameter 'deploymentName' should be defined with a 'pattern' restriction.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L1401
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:name.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L1538
❌ 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.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L1571
❌ ResourceNameRestriction The resource name parameter 'deploymentName' should be defined with a 'pattern' restriction.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L1619
❌ ResourceNameRestriction The resource name parameter 'commitmentPlanName' should be defined with a 'pattern' restriction.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.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.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L1814
❌ ParametersSchemaAsTypeObject The schema for body parameters must specify type:object and include a definition for its reference model.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L2703
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:name.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L2942
❌ 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.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L2981
❌ 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.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3244
❌ 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.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3244
❌ 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.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L3306
❌ ProvisioningStateValidation ProvisioningState must have terminal states: Succeeded, Failed and Canceled.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L5037
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L5169
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L5218
❌ TrackedResourcePatchOperation Tracked resource 'PrivateEndpointConnection' must have patch operation that at least supports the update of tags.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L6408
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L6603
❌ TrackedResourcePatchOperation Tracked resource 'CommitmentPlan' must have patch operation that at least supports the update of tags.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L6879
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L7160
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L7167
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L47
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L62
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L65
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L90
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L109
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L124
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L127
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L146
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L165
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L171
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L174
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v6 of types.json.
Location: Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json#L190
View more details on openapi-pipeline-app