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.

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

Navigate API public preview #28191

Merged
merged 5 commits into from
May 8, 2024

update example

6359f9b
Select commit
Loading
Failed to load commit list.
Merged

Navigate API public preview #28191

update example
6359f9b
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff completed Apr 30, 2024 in 4m 8s

Swagger LintDiff failed

LintDiff: 0 Errors, 549 Warnings
The check status is neutral due to the check being suppressed by the label Approved-LintDiff.
View Azure DevOps build log for more details.

Details

Compared specs (v2.2.1) new version base version
package-preview-2024-03 package-preview-2024-03(6359f9b) default(main)

[must fix]The following errors/warnings are introduced by current PR:
Only 50 items are listed, please refer to log for more details.

Rule Message Related RPC [For API reviewers]
⚠️ SecurityDefinitionDescription Security definition should have a description.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L42
⚠️ VersionPolicy 'api-version' should be a required parameter
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L58
⚠️ VersionPolicy 'api-version' should be a required parameter
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L145
⚠️ 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/preview/2024-03-01-preview/purviewdatamap.json#L159
⚠️ 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/preview/2024-03-01-preview/purviewdatamap.json#L166
⚠️ VersionPolicy 'api-version' should be a required parameter
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L198
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L382
⚠️ 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/preview/2024-03-01-preview/purviewdatamap.json#L389
⚠️ 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/preview/2024-03-01-preview/purviewdatamap.json#L396
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L500
⚠️ 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/preview/2024-03-01-preview/purviewdatamap.json#L507
⚠️ 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/preview/2024-03-01-preview/purviewdatamap.json#L514
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L546
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L592
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L626
⚠️ AdditionalPropertiesObject additionalProperties with type object is a common error.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L648
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L676
⚠️ AdditionalPropertiesObject additionalProperties with type object is a common error.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L690
⚠️ VersionPolicy Version segment 'v2' in path violates Azure versioning policy.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L715
⚠️ ParameterOrder Path parameter 'guid' should appear before 'businessMetadataName'.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L719
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L719
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L720
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L727
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L749
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L751
⚠️ DeleteInOperationName 'DELETE' operation 'Entity_RemoveBusinessMetadataAttributes' 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/preview/2024-03-01-preview/purviewdatamap.json#L763
⚠️ OperationId OperationId for delete method should contain 'Delete'
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L763
⚠️ ParameterOrder Path parameter 'guid' should appear before 'businessMetadataName'.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L765
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L765
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L766
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L773
⚠️ RequestBodyNotAllowed A get or delete operation must not accept a body parameter.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L782
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L795
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L797
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L814
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L821
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L853
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L860
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L891
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L923
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L965
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L1009
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L1043
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L1084
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L1125
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L1168
⚠️ 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/preview/2024-03-01-preview/purviewdatamap.json#L1175
⚠️ 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/preview/2024-03-01-preview/purviewdatamap.json#L1182
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L1222
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L1270


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

Rule Message
⚠️ VersionPolicy Version segment 'v2' in path violates Azure versioning policy.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L53
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L54
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L117
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L119
⚠️ VersionPolicy Version segment 'v2' in path violates Azure versioning policy.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L140
⚠️ 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/preview/2024-03-01-preview/purviewdatamap.json#L141
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L141
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L181
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L183
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L194
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L257
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L259
⚠️ 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/preview/2024-03-01-preview/purviewdatamap.json#L271
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L273
⚠️ Delete204Response A delete operation should have a 204 response.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L286
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L293
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L295
⚠️ VersionPolicy Version segment 'v2' in path violates Azure versioning policy.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L307
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L311
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L325
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L327
⚠️ VersionPolicy Version segment 'v2' in path violates Azure versioning policy.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L339
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L343
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L363
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L365
⚠️ VersionPolicy Version segment 'v2' in path violates Azure versioning policy.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L377
⚠️ 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/preview/2024-03-01-preview/purviewdatamap.json#L378
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L378
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L381
⚠️ ParameterNamesConvention Parameter name 'attr_N:qualifiedName' should be camel case.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L404
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L418
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L420
⚠️ VersionPolicy Version segment 'v2' in path violates Azure versioning policy.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L432
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L433
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L439
⚠️ Formdata Check for appropriate use of formData parameters.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L440
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L451
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L453
⚠️ VersionPolicy Version segment 'v2' in path violates Azure versioning policy.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L465
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L473
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L481
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L483
⚠️ VersionPolicy Version segment 'v2' in path violates Azure versioning policy.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L495
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L499
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L529
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L531
⚠️ PutInOperationName 'PUT' operation 'Entity_PartialUpdateAttributeByGuid' 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: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L543
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L545
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L575
⚠️ ErrorResponse Error response schema should contain an object property named error.
Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L577