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

Fix broken links in user docs (description fields) #27149

Merged
merged 18 commits into from
Jan 16, 2024

Merge branch 'main' into broken-links-12-19-23

fbad974
Select commit
Loading
Failed to load commit list.
Merged

Fix broken links in user docs (description fields) #27149

Merge branch 'main' into broken-links-12-19-23
fbad974
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / ~[NotRequired_Staging] Swagger LintDiff succeeded Jan 16, 2024 in 4m 17s

~[NotRequired_Staging] Swagger LintDiff succeeded

ppe/LintDiff
View Azure DevOps build log for more details.

Details

compared tags (via openapi-validator vbeta) 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
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Creator/preview/2.0/tileset.json#L314
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Creator/preview/2.0/tileset.json#L309
❌ ValidFormats 'file' is not a known format.
Location: Render/preview/2.0/render.json#L277
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Tileset/preview/2.0/tileset.json#L585
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Tileset/preview/2.0/tileset.json#L580
❌ LroExtension 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 defined
Location: Tileset/preview/2.0/tileset.json#L227
❌ XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
Location: Render/preview/2.0/render.json#L235
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Creator/preview/2023-03-01-preview/features.json#L1081
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Creator/preview/2023-03-01-preview/features.json#L1059
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Creator/preview/2023-03-01-preview/features.json#L1050
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Creator/preview/2023-03-01-preview/features.json#L968
⚠️ 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: Creator/preview/2023-03-01-preview/features.json#L927
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Creator/preview/2023-03-01-preview/features.json#L634
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Creator/preview/2023-03-01-preview/features.json#L609
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Creator/preview/2023-03-01-preview/features.json#L566
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Creator/preview/2023-03-01-preview/features.json#L566
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Creator/preview/2023-03-01-preview/features.json#L566
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Creator/preview/2023-03-01-preview/features.json#L558
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Creator/preview/2023-03-01-preview/features.json#L555
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Creator/preview/2023-03-01-preview/features.json#L552
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Creator/preview/2023-03-01-preview/features.json#L535
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Creator/preview/2023-03-01-preview/features.json#L535
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Creator/preview/2023-03-01-preview/features.json#L535
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Creator/preview/2023-03-01-preview/features.json#L524
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Creator/preview/2023-03-01-preview/features.json#L521
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Creator/preview/2023-03-01-preview/features.json#L518
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Creator/preview/2023-03-01-preview/features.json#L498
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Creator/preview/2023-03-01-preview/features.json#L498
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Creator/preview/2023-03-01-preview/features.json#L498
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Creator/preview/2023-03-01-preview/features.json#L487
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Creator/preview/2023-03-01-preview/features.json#L484
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Creator/preview/2023-03-01-preview/features.json#L481
⚠️ PutInOperationName 'PUT' operation 'Features_Replace' 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: Creator/preview/2023-03-01-preview/features.json#L468
⚠️ OperationId OperationId for put method should contain 'Create' or 'Update'
Location: Creator/preview/2023-03-01-preview/features.json#L468
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Creator/preview/2023-03-01-preview/features.json#L461
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Creator/preview/2023-03-01-preview/features.json#L461
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Creator/preview/2023-03-01-preview/features.json#L461
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Creator/preview/2023-03-01-preview/features.json#L450
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Creator/preview/2023-03-01-preview/features.json#L447
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Creator/preview/2023-03-01-preview/features.json#L444
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Creator/preview/2023-03-01-preview/features.json#L432
⚠️ PageableOperation Based on the response model schema, operation 'Features_Get' might be pageable. Consider adding the x-ms-pageable extension.
Location: Creator/preview/2023-03-01-preview/features.json#L432
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Creator/preview/2023-03-01-preview/features.json#L425
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Creator/preview/2023-03-01-preview/features.json#L425
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Creator/preview/2023-03-01-preview/features.json#L425
⚠️ Post201Response Using post for a create operation is discouraged.
Location: Creator/preview/2023-03-01-preview/features.json#L419
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Creator/preview/2023-03-01-preview/features.json#L411
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Creator/preview/2023-03-01-preview/features.json#L408
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Creator/preview/2023-03-01-preview/features.json#L393
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Creator/preview/2023-03-01-preview/features.json#L388
View more details on openapi-pipeline-app