Fix broken links in user docs (description fields) #27149
Merged
openapi-pipeline-app / Swagger LintDiff
succeeded
Jan 16, 2024 in 4m 23s
Swagger LintDiff succeeded
Details
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-stable-V2 | package-stable-V2(fbad974) | package-stable-V2(main) |
| package-2023-03-preview | package-2023-03-preview(fbad974) | package-2023-03-preview(main) |
| package-2022-09-preview | package-2022-09-preview(fbad974) | package-2022-09-preview(main) |
| package-creator | package-creator(fbad974) | package-creator(main) |
| package-deprecated | package-deprecated(fbad974) | package-deprecated(main) |
| 2.1 | 2.1(fbad974) | 2.1(main) |
| 2.0 | 2.0(fbad974) | 2.0(main) |
The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The integer type does not have a format, please add it. Location: Creator/preview/2.0/tileset.json#L309 |
|
The integer type does not have a format, please add it. Location: Creator/preview/2.0/tileset.json#L314 |
|
'file' is not a known format. Location: Render/preview/2.0/render.json#L277 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Render/preview/2.0/render.json#L235 |
|
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: Tileset/preview/2.0/tileset.json#L227 |
|
The integer type does not have a format, please add it. Location: Tileset/preview/2.0/tileset.json#L580 |
|
The integer type does not have a format, please add it. Location: Tileset/preview/2.0/tileset.json#L585 |
| API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: Creator/preview/2.0/dwgconversion.json#L5 |
|
| API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: Creator/preview/2.0/dwgconversion.json#L5 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConversionModel'. Consider using the plural form of 'Conversion' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2.0/dwgconversion.json#L128 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConversionModel'. Consider using the plural form of 'Conversion' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2.0/dwgconversion.json#L128 |
|
| A required parameter should not specify a default value. Location: Creator/preview/2.0/dwgconversion.json#L142 |
|
| A required parameter should not specify a default value. Location: Creator/preview/2.0/dwgconversion.json#L142 |
|
| Error response should contain a x-ms-error-code header. Location: Creator/preview/2.0/dwgconversion.json#L162 |
|
The error property in the error response schema should be required.Location: Creator/preview/2.0/dwgconversion.json#L162 |
|
Error schema should define code and message properties as required.Location: Creator/preview/2.0/dwgconversion.json#L162 |
|
| Error response should contain a x-ms-error-code header. Location: Creator/preview/2.0/dwgconversion.json#L162 |
|
The error property in the error response schema should be required.Location: Creator/preview/2.0/dwgconversion.json#L162 |
|
Error schema should define code and message properties as required.Location: Creator/preview/2.0/dwgconversion.json#L162 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConversionModel'. Consider using the plural form of 'Conversion' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2.0/dwgconversion.json#L169 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConversionModel'. Consider using the plural form of 'Conversion' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2.0/dwgconversion.json#L169 |
|
| A required parameter should not specify a default value. Location: Creator/preview/2.0/dwgconversion.json#L179 |
|
| A required parameter should not specify a default value. Location: Creator/preview/2.0/dwgconversion.json#L179 |
|
Response body schema of pageable response should contain top-level array property valueLocation: Creator/preview/2.0/dwgconversion.json#L190 |
|
Response body schema of pageable response should contain top-level array property valueLocation: Creator/preview/2.0/dwgconversion.json#L190 |
|
| Error response should contain a x-ms-error-code header. Location: Creator/preview/2.0/dwgconversion.json#L194 |
|
The error property in the error response schema should be required.Location: Creator/preview/2.0/dwgconversion.json#L194 |
|
Error schema should define code and message properties as required.Location: Creator/preview/2.0/dwgconversion.json#L194 |
|
| Error response should contain a x-ms-error-code header. Location: Creator/preview/2.0/dwgconversion.json#L194 |
|
The error property in the error response schema should be required.Location: Creator/preview/2.0/dwgconversion.json#L194 |
|
Error schema should define code and message properties as required.Location: Creator/preview/2.0/dwgconversion.json#L194 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConversionModel'. Consider using the plural form of 'Conversion' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2.0/dwgconversion.json#L203 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConversionModel'. Consider using the plural form of 'Conversion' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2.0/dwgconversion.json#L203 |
|
| A required parameter should not specify a default value. Location: Creator/preview/2.0/dwgconversion.json#L213 |
|
| A required parameter should not specify a default value. Location: Creator/preview/2.0/dwgconversion.json#L213 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Creator/preview/2.0/dwgconversion.json#L216 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Creator/preview/2.0/dwgconversion.json#L216 |
|
| Error response should contain a x-ms-error-code header. Location: Creator/preview/2.0/dwgconversion.json#L227 |
|
The error property in the error response schema should be required.Location: Creator/preview/2.0/dwgconversion.json#L227 |
|
Error schema should define code and message properties as required.Location: Creator/preview/2.0/dwgconversion.json#L227 |
|
| Error response should contain a x-ms-error-code header. Location: Creator/preview/2.0/dwgconversion.json#L227 |
|
The error property in the error response schema should be required.Location: Creator/preview/2.0/dwgconversion.json#L227 |
|
Error schema should define code and message properties as required.Location: Creator/preview/2.0/dwgconversion.json#L227 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConversionModel'. Consider using the plural form of 'Conversion' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2.0/dwgconversion.json#L234 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConversionModel'. Consider using the plural form of 'Conversion' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2.0/dwgconversion.json#L234 |
|
| A required parameter should not specify a default value. Location: Creator/preview/2.0/dwgconversion.json#L244 |
|
| A required parameter should not specify a default value. Location: Creator/preview/2.0/dwgconversion.json#L244 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Creator/preview/2.0/dwgconversion.json#L247 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Creator/preview/2.0/dwgconversion.json#L247 |
|
| Error response should contain a x-ms-error-code header. Location: Creator/preview/2.0/dwgconversion.json#L255 |
Loading