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 spread for purview datamap and translation document #29707

Merged
merged 15 commits into from
Jul 9, 2024
+146 −100

format

4c890d6
Select commit
Loading
Failed to load commit list.
Merged

fix spread for purview datamap and translation document #29707

format
4c890d6
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Jul 9, 2024 in 4m 24s

Swagger LintDiff succeeded

LintDiff
View Azure DevOps build log for more details.

Details

Compared specs (v2.2.2) new version base version
package-2023-09 package-2023-09(4c890d6) package-2023-09(main)
2024-05-01 2024-05-01(4c890d6) 2024-05-01(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ 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: Azure.AI.DocumentTranslation/stable/2024-05-01/openapi.json#L1422


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

Rule Message
⚠️ SecurityDefinitionDescription Security definition should have a description.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L42
⚠️ VersionPolicy Version segment 'v2' in path violates Azure versioning policy.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L53
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L54
⚠️ VersionPolicy 'api-version' should be a required parameter
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L58
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L118
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L120
⚠️ VersionPolicy Version segment 'v2' in path violates Azure versioning policy.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L141
⚠️ PageableOperation Based on the response model schema, operation 'Entity_ListByGuids' might be pageable. Consider adding the x-ms-pageable extension.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L142
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L142
⚠️ VersionPolicy 'api-version' should be a required parameter
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L146
⚠️ 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: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L160
⚠️ 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: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L167
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L182
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L184
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L195
⚠️ VersionPolicy 'api-version' should be a required parameter
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L199
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L259
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L261
⚠️ DeleteInOperationName 'DELETE' operation 'Entity_BulkDelete' should use method name 'Delete'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L273
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L275
⚠️ Delete204Response A delete operation should have a 204 response.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L288
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L295
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L297
⚠️ VersionPolicy Version segment 'v2' in path violates Azure versioning policy.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L309
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L313
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L328
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L330
⚠️ VersionPolicy Version segment 'v2' in path violates Azure versioning policy.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L342
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L346
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L367
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L369
⚠️ VersionPolicy Version segment 'v2' in path violates Azure versioning policy.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L381
⚠️ PageableOperation Based on the response model schema, operation 'Entity_ListByUniqueAttributes' might be pageable. Consider adding the x-ms-pageable extension.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L382
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L382
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L385
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L386
⚠️ 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: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L393
⚠️ 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: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L400
⚠️ ParameterNamesConvention Parameter name 'attr_N:qualifiedName' should be camel case.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L408
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L422
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L424
⚠️ VersionPolicy Version segment 'v2' in path violates Azure versioning policy.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L436
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L437
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L443
⚠️ Formdata Check for appropriate use of formData parameters.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L444
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L459
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L461
⚠️ VersionPolicy Version segment 'v2' in path violates Azure versioning policy.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L473
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L481
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L489
View more details on openapi-pipeline-app