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
Merged

Conversation

SerenaLin2020
Copy link
Member

Data Plane API - Pull Request

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

  • Link to API Spec engagement record issue:

Is this review for (select one):

  • a private preview
  • a public preview
  • GA release

Change Scope

This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.

  • Design Document:
  • Previous API Spec Doc:
  • Updated paths:

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

Checks stuck in `queued` state? If the PR CI checks appear to be stuck in `queued` state, please add a comment with contents `/azp run`. This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes.

@SerenaLin2020 SerenaLin2020 requested review from mikekistler and a team as code owners March 11, 2024 09:11
@SerenaLin2020 SerenaLin2020 requested review from tg-msft and removed request for a team March 11, 2024 09:11
Copy link

openapi-pipeline-app bot commented Mar 11, 2024

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Copy link

openapi-pipeline-app bot commented Mar 11, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 575 Warnings warning [Detail]
Compared specs (v0.10.8) new version base version
purviewdatamap.json 2024-03-01-preview(6359f9b) 2023-09-01(main)
purviewdatamap.json 2024-03-01-preview(6359f9b) 2023-10-01-preview(main)

The following breaking changes are detected by comparison with the latest preview version:

Only 30 items are listed, please refer to log for more details.

Rule Message
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/entity/bulk/delete' removed or restructured?
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L1557:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/entity/operations/{operationId}' removed or restructured?
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L1627:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/lineage/{guid}/next/' removed or restructured?
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L3103:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/audit/query' removed or restructured?
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L4115:5
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'TermCustomAttributes' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L4582:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L4158:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ClassificationAssociateRequest' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L4582:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L4158:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'MoveEntitiesRequest' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L4582:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L4158:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'Status' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L4582:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L4158:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'Status_AtlasRelationship' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L4582:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L4158:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AutoCompleteRequest' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L4582:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L4158:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'SearchRequest' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L4582:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L4158:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'SuggestRequest' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L4582:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L4158:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'LastModifiedTS' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L4582:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L4158:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'BusinessMetadata' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L4582:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L4158:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'BusinessMetadataAttributes' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L4582:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L4158:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AuditLogQueryRequest' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L4582:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L4158:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AuditCategory' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L4582:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L4158:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AuditOperationType' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L4582:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L4158:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AuditSortOrder' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L4582:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L4158:3
⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'endpoint' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L8418:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L7233:3
⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'guid' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L8418:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L7233:3
⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'classificationName' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L8418:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L7233:3
⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'typeName' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L8418:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L7233:3
⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'categoryGuid' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L8418:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L7233:3
⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'limit' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L8418:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L7233:3
⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'offset' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L8418:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L7233:3
⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'sort' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L8418:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L7233:3
⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'termGuid' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L8418:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L7233:3
⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'fileId' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L8418:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L7233:3
⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'glossaryGuid' removed or renamed?
New: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L8418:3
Old: Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json#L7233:3
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 0 Errors, 227 Warnings failed [Detail]
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 30 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


The following errors/warnings exist before current PR submission:

Only 30 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
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Mar 11, 2024

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️❌ azure-sdk-for-net-track2 failed [Detail]
  • Failed in generating from 800d5290a73a151d20c1a7417930bc26bf54f633. SDK Automation 14.0.0
    Only showing 20 items here. Refer to log for details.
    cmderr	[Invoke-GenerateAndBuildV2.ps1]  714 |          GeneratePackage -projectFolder $projectFolder -sdkRootPath $s …
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      |          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to generate sdk artifact
    cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
    cmderr	[Invoke-GenerateAndBuildV2.ps1]  714 |          GeneratePackage -projectFolder $projectFolder -sdkRootPath $s …
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      |          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to generate sdk. exit code: False
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Get-ChildItem: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
    cmderr	[Invoke-GenerateAndBuildV2.ps1]  807 |  … rtifacts += Get-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s …
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Cannot find path
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | it does not exist.
    cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
    cmderr	[Invoke-GenerateAndBuildV2.ps1]  714 |          GeneratePackage -projectFolder $projectFolder -sdkRootPath $s …
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      |          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to generate sdk artifact
  • Azure.Analytics.Purview.Account [Preview SDK Changes]
    info	[Changelog]
  • Azure.Analytics.Purview.Administration [Preview SDK Changes]
    info	[Changelog]
  • Azure.Analytics.Purview.Catalog [Preview SDK Changes]
    info	[Changelog]
  • Azure.Analytics.Purview.Scanning [Preview SDK Changes]
    info	[Changelog]
  • Azure.Analytics.Purview.Sharing [Preview SDK Changes]
    info	[Changelog]
  • Azure.Analytics.Purview.Workflows [Preview SDK Changes]
    info	[Changelog]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Mar 11, 2024

Generated ApiView

Language Package Name ApiView Link
Swagger Azure.Analytics.Purview.DataMap https://apiview.dev/Assemblies/Review/17f9d062cae340bd9a831088c8b58219?revisionId=82c7733d82df4211985043b48e2d3e09

@SerenaLin2020
Copy link
Member Author

Preview Azure Board review meeting notes: #26429

@weidongxu-microsoft
Copy link
Member

I am OK with the API.

But all those error in "Breaking Change(Cross-Version)" need to be approved separately. My recommendation is go with the typespec.

@mikekistler mikekistler requested a review from heaths April 15, 2024 13:05
@AzureRestAPISpecReview AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Apr 23, 2024
@SerenaLin2020 SerenaLin2020 force-pushed the serenalin_2024_03_01_preview branch 2 times, most recently from 3a16945 to f3f1ca8 Compare April 23, 2024 13:39
@SerenaLin2020 SerenaLin2020 force-pushed the serenalin_2024_03_01_preview branch from f3f1ca8 to 2f5ff98 Compare April 23, 2024 13:49
@AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required TypeSpec Authored with TypeSpec and removed BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Apr 23, 2024
@SerenaLin2020 SerenaLin2020 force-pushed the serenalin_2024_03_01_preview branch from e1c9a80 to 3d21068 Compare April 24, 2024 01:04
@SerenaLin2020 SerenaLin2020 force-pushed the serenalin_2024_03_01_preview branch from 3d21068 to dd9aae3 Compare April 24, 2024 05:37
@weidongxu-microsoft weidongxu-microsoft added the APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. label Apr 28, 2024
Comment on lines 8004 to 8159
"items": {
"$ref": "#/definitions/ContactSearchResultValue"
}
},
"assetType": {
"type": "array",
"description": "The asset types of the asset

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Model with only additionalProperties should be used with caution.

Is there nothing you have on its schema?

@weidongxu-microsoft
Copy link
Member

The LintDiff CI seems not working as expected. I've opened an issue for this Azure/azure-sdk-tools#8165

@weidongxu-microsoft weidongxu-microsoft self-requested a review April 29, 2024 01:36
@tjprescott tjprescott removed the TypeSpec Authored with TypeSpec label Apr 29, 2024
@AzureRestAPISpecReview AzureRestAPISpecReview added the TypeSpec Authored with TypeSpec label Apr 30, 2024
@SerenaLin2020 SerenaLin2020 force-pushed the serenalin_2024_03_01_preview branch from 6c92f5a to ac2c689 Compare April 30, 2024 06:39
@weidongxu-microsoft
Copy link
Member

Ignore the LintDiff, as error is about /sentShare which is not in this tsp/swagger.
Azure/azure-sdk-tools#8165 (comment)

@weidongxu-microsoft weidongxu-microsoft merged commit dd1b1d0 into main May 8, 2024
31 of 32 checks passed
@weidongxu-microsoft weidongxu-microsoft deleted the serenalin_2024_03_01_preview branch May 8, 2024 02:31
Francisco-Gamino pushed a commit to Francisco-Gamino/azure-rest-api-specs that referenced this pull request Jun 5, 2024
* generate base from 2023-09-01

* add navigate API

* update example

* update ErrorResponse to AtlasErrorResponse

* update example
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. Approved-LintDiff data-plane new-api-version TypeSpec Authored with TypeSpec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants