Add 2024-05-15-preview of SpeechToText API (CognitiveServices) #29804
openapi-pipeline-app / Swagger LintDiff
succeeded
Jul 12, 2024 in 4m 17s
Swagger LintDiff succeeded
Details
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| release_2024_05_15_preview | release_2024_05_15_preview(c3c82e5) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| 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: 'Datasets_UploadBlock' Request Model: 'parameters[3].schema' Response Model: 'responses[201].schema' Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L369 |
||
| Parameter should have a description. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L400 |
||
| Based on the response model schema, operation 'Transcriptions_ListSupportedLocales' might be pageable. Consider adding the x-ms-pageable extension. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L3182 |
||
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L3182 |
||
| Using post for a create operation is discouraged. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L3459 |
||
| Error response should contain a x-ms-error-code header. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L3472 |
||
Error response schema should contain an object property named error.Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L3474 |
||
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L3997 |
||
| OperationId should be of the form 'Noun_Verb' Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L4002 |
||
| Check for appropriate use of formData parameters. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L4013 |
||
| Check for appropriate use of formData parameters. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L4020 |
||
| Operation is missing a default response. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L4029 |
||
| Property should have a description. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L4443 |
||
| Property should have a description. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L4449 |
||
| Property should have a description. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L4455 |
||
| Property should have a description. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L4461 |
||
| Property should have a description. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L4467 |
||
| Property should have a description. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L4473 |
||
| 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: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L6404 |
||
| 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: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L6409 |
||
| Property should have a description. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L6611 |
||
| Property should have a description. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L6617 |
||
| Schema should have a description or title. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L6945 |
The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L984 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L1189 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L3896 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L3945 |
| Error response should contain a x-ms-error-code header. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L35 |
|
Error response schema should contain an object property named error.Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L37 |
|
Response body schema of pageable response should contain top-level array property valueLocation: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L79 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L90 |
|
Error response schema should contain an object property named error.Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L92 |
|
| Using post for a create operation is discouraged. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L137 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L150 |
|
Error response schema should contain an object property named error.Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L152 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L178 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L204 |
|
Error response schema should contain an object property named error.Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L206 |
|
| A patch operation should only consume 'application/merge-patch+json' content type. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L223 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L231 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L266 |
|
Error response schema should contain an object property named error.Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L268 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L289 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L305 |
|
Error response schema should contain an object property named error.Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L307 |
|
| The path for a put should have a final path parameter. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L319 |
|
| Based on the response model schema, operation 'Datasets_GetBlocks' might be pageable. Consider adding the x-ms-pageable extension. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L320 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L320 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L330 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L356 |
|
Error response schema should contain an object property named error.Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L358 |
|
| OperationId for put method should contain 'Create' Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L374 |
|
| 'PUT' operation 'Datasets_UploadBlock' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L374 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L382 |
|
| All success responses except 202 & 204 should define a response body. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L411 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L414 |
|
Error response schema should contain an object property named error.Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L416 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L442 |
|
| All success responses except 202 & 204 should define a response body. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L467 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L470 |
|
Error response schema should contain an object property named error.Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L472 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L495 |
|
Response body schema of pageable response should contain top-level array property valueLocation: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L525 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L536 |
|
Error response schema should contain an object property named error.Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L538 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L568 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L576 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L598 |
|
Error response schema should contain an object property named error.Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L600 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L637 |
|
Error response schema should contain an object property named error.Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L639 |
|
Response body schema of pageable response should contain top-level array property valueLocation: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L681 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/preview/2024-05-15-preview/speechtotext.json#L692 |
Loading