Add v3.2 for Speech to text (3.2p2 as base) #28664
Merged
openapi-pipeline-app / Swagger LintDiff
succeeded
May 16, 2024 in 3m 26s
Swagger LintDiff succeeded
Details
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| release_3_2 | release_3_2(48ec476) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: SpeechToText/stable/v3.2/speechtotext.json#L2133 |
RPC-Async-V1-05 | |
| Operation does not define an 'api-version' query parameter. Location: SpeechToText/stable/v3.2/speechtotext.json#L2147 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: SpeechToText/stable/v3.2/speechtotext.json#L2148 |
||
| Error response should contain a x-ms-error-code header. Location: SpeechToText/stable/v3.2/speechtotext.json#L2185 |
||
Error response schema should contain an object property named error.Location: SpeechToText/stable/v3.2/speechtotext.json#L2187 |
||
| Operation does not define an 'api-version' query parameter. Location: SpeechToText/stable/v3.2/speechtotext.json#L2214 |
||
| Error response should contain a x-ms-error-code header. Location: SpeechToText/stable/v3.2/speechtotext.json#L2232 |
||
Error response schema should contain an object property named error.Location: SpeechToText/stable/v3.2/speechtotext.json#L2234 |
||
| Operation does not define an 'api-version' query parameter. Location: SpeechToText/stable/v3.2/speechtotext.json#L2463 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: SpeechToText/stable/v3.2/speechtotext.json#L2464 |
||
| Error response should contain a x-ms-error-code header. Location: SpeechToText/stable/v3.2/speechtotext.json#L2487 |
||
Error response schema should contain an object property named error.Location: SpeechToText/stable/v3.2/speechtotext.json#L2489 |
||
| 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/stable/v3.2/speechtotext.json#L3941 |
||
| Property should have a defined type. Location: SpeechToText/stable/v3.2/speechtotext.json#L5666 |
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/stable/v3.2/speechtotext.json#L1021 |
|
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/stable/v3.2/speechtotext.json#L1214 |
|
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/stable/v3.2/speechtotext.json#L3764 |
|
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/stable/v3.2/speechtotext.json#L3810 |
| API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: SpeechToText/stable/v3.2/speechtotext.json#L10 |
|
| Operation does not define an 'api-version' query parameter. Location: SpeechToText/stable/v3.2/speechtotext.json#L14 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/stable/v3.2/speechtotext.json#L30 |
|
Error response schema should contain an object property named error.Location: SpeechToText/stable/v3.2/speechtotext.json#L32 |
|
| Operation does not define an 'api-version' query parameter. Location: SpeechToText/stable/v3.2/speechtotext.json#L54 |
|
Response body schema of pageable response should contain top-level array property valueLocation: SpeechToText/stable/v3.2/speechtotext.json#L71 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/stable/v3.2/speechtotext.json#L82 |
|
Error response schema should contain an object property named error.Location: SpeechToText/stable/v3.2/speechtotext.json#L84 |
|
| Operation does not define an 'api-version' query parameter. Location: SpeechToText/stable/v3.2/speechtotext.json#L114 |
|
| Using post for a create operation is discouraged. Location: SpeechToText/stable/v3.2/speechtotext.json#L126 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/stable/v3.2/speechtotext.json#L139 |
|
Error response schema should contain an object property named error.Location: SpeechToText/stable/v3.2/speechtotext.json#L141 |
|
| Operation does not define an 'api-version' query parameter. Location: SpeechToText/stable/v3.2/speechtotext.json#L166 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: SpeechToText/stable/v3.2/speechtotext.json#L167 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/stable/v3.2/speechtotext.json#L190 |
|
Error response schema should contain an object property named error.Location: SpeechToText/stable/v3.2/speechtotext.json#L192 |
|
| A patch operation should only consume 'application/merge-patch+json' content type. Location: SpeechToText/stable/v3.2/speechtotext.json#L209 |
|
| Operation does not define an 'api-version' query parameter. Location: SpeechToText/stable/v3.2/speechtotext.json#L216 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: SpeechToText/stable/v3.2/speechtotext.json#L217 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/stable/v3.2/speechtotext.json#L249 |
|
Error response schema should contain an object property named error.Location: SpeechToText/stable/v3.2/speechtotext.json#L251 |
|
| Operation does not define an 'api-version' query parameter. Location: SpeechToText/stable/v3.2/speechtotext.json#L271 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: SpeechToText/stable/v3.2/speechtotext.json#L272 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/stable/v3.2/speechtotext.json#L285 |
|
Error response schema should contain an object property named error.Location: SpeechToText/stable/v3.2/speechtotext.json#L287 |
|
| The path for a put should have a final path parameter. Location: SpeechToText/stable/v3.2/speechtotext.json#L299 |
|
| Based on the response model schema, operation 'Datasets_GetBlocks' might be pageable. Consider adding the x-ms-pageable extension. Location: SpeechToText/stable/v3.2/speechtotext.json#L300 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: SpeechToText/stable/v3.2/speechtotext.json#L300 |
|
| Operation does not define an 'api-version' query parameter. Location: SpeechToText/stable/v3.2/speechtotext.json#L309 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: SpeechToText/stable/v3.2/speechtotext.json#L310 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/stable/v3.2/speechtotext.json#L333 |
|
Error response schema should contain an object property named error.Location: SpeechToText/stable/v3.2/speechtotext.json#L335 |
|
| 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[2].schema' Response Model: 'responses[201].schema' Location: SpeechToText/stable/v3.2/speechtotext.json#L346 |
|
| OperationId for put method should contain 'Create' Location: SpeechToText/stable/v3.2/speechtotext.json#L351 |
|
| '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/stable/v3.2/speechtotext.json#L351 |
|
| Operation does not define an 'api-version' query parameter. Location: SpeechToText/stable/v3.2/speechtotext.json#L358 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: SpeechToText/stable/v3.2/speechtotext.json#L359 |
|
| Parameter should have a description. Location: SpeechToText/stable/v3.2/speechtotext.json#L374 |
|
| All success responses except 202 & 204 should define a response body. Location: SpeechToText/stable/v3.2/speechtotext.json#L385 |
|
| Error response should contain a x-ms-error-code header. Location: SpeechToText/stable/v3.2/speechtotext.json#L388 |
|
Error response schema should contain an object property named error.Location: SpeechToText/stable/v3.2/speechtotext.json#L390 |
|
| Operation does not define an 'api-version' query parameter. Location: SpeechToText/stable/v3.2/speechtotext.json#L415 |
|
| Check for appropriate use of formData parameters. Location: SpeechToText/stable/v3.2/speechtotext.json#L416 |
|
| Check for appropriate use of formData parameters. Location: SpeechToText/stable/v3.2/speechtotext.json#L422 |
|
| Check for appropriate use of formData parameters. Location: SpeechToText/stable/v3.2/speechtotext.json#L429 |
|
| Check for appropriate use of formData parameters. Location: SpeechToText/stable/v3.2/speechtotext.json#L435 |
Loading