Add Browse API to Purview.Catalog #14602

yifan-zhou922 · 2021-05-31T02:50:53Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
- Adding new API(s)
- Adding a new API version
- Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
- Adding a new service
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2021-05-31T02:50:55Z

Hi, @yifan-zhou922 Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

openapi-workflow-bot · 2021-05-31T02:50:56Z

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

openapi-pipeline-app · 2021-05-31T02:50:56Z

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.8.9)
- current:preview/2021-05-01-preview/purviewcatalog.json compared with base:preview/2021-05-01-preview/purviewcatalog.json

Rule	Message
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/purviewcatalog.json#L2196:5

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

Linted configuring files (Based on source branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- purview/data-plane/readme.md tag:package-2021-05-01-preview
Linted configuring files (Based on target branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- purview/data-plane/readme.md tag:package-2021-05-01-preview

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️[Staging] SDK Track2 Validation: 0 Warnings warning [Detail]

The following tags are being changed in this PR

purview/data-plane/readme.md#package-2021-05-01-preview

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"purview/data-plane/readme.md",
"tag":"package-2021-05-01-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"purview/data-plane/readme.md",
"tag":"package-2021-05-01-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ ?	"readme":"purview/data-plane/readme.md", "tag":"package-2021-05-01-preview", "details":"Operation 'Glossary/DeleteTermAssignmentFromEntities' really should not have a media type (because there should be no body)"
⚠️ ?	"readme":"purview/data-plane/readme.md", "tag":"package-2021-05-01-preview", "details":"Operation 'Types/DeleteTypeDefinitions' really should not have a media type (because there should be no body)"
💬 AutorestCore/Exception	"readme":"purview/data-plane/readme.md", "tag":"package-2021-05-01-preview", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"

️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2021-05-31T02:50:56Z

Swagger pipeline restarted successfully, please wait for status update in this comment.

openapi-workflow-bot · 2021-05-31T02:52:40Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

jhendrixMSFT · 2021-06-01T16:24:24Z

@yifan-zhou922 was this breaking change reviewed and approved?

yifan-zhou922 · 2021-06-02T01:48:06Z

@jhendrixMSFT Yes. This has been reviewed and approved.

lmazuel · 2021-06-02T22:21:53Z

...ew/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/purviewcatalog.json

+          "Discovery"
+        ],
+        "description": "Browse entities by path or entity type.",
+        "operationId": "Discovery_Browse",


Needs review by archboard

The API has been reviewed by SDK team.

lmazuel · 2021-06-02T22:22:07Z

...ew/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/purviewcatalog.json

+        "parameters": [
+          {
+            "in": "body",
+            "name": "browseRequest",


Needs review by archboard

The API has been reviewed by SDK team.

* add browse api * add api-version in browse api

add browse api

4c51a6d

openapi-assignment-bot bot assigned jhendrixMSFT May 31, 2021

openapi-pipeline-app bot added the NewApiVersionRequired label May 31, 2021

yifan-zhou922 changed the title ~~Add Browse API in Purview.Catalog~~ Add Browse API to Purview.Catalog May 31, 2021

jhendrixMSFT approved these changes Jun 1, 2021

View reviewed changes

add api-version in browse api

5620f74

lmazuel assigned lmazuel and unassigned jhendrixMSFT Jun 2, 2021

lmazuel reviewed Jun 2, 2021

View reviewed changes

lmazuel approved these changes Jun 17, 2021

View reviewed changes

lmazuel merged commit 12c11b2 into master Jun 17, 2021

lmazuel deleted the yifanzhou/browse branch June 17, 2021 18:18

asager pushed a commit to asager/azure-rest-api-specs that referenced this pull request Jun 24, 2021

Add Browse API to Purview.Catalog (Azure#14602)

e0eeb18

* add browse api * add api-version in browse api

mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021

Add Browse API to Purview.Catalog (Azure#14602)

2f96911

* add browse api * add api-version in browse api

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Browse API to Purview.Catalog #14602

Add Browse API to Purview.Catalog #14602

yifan-zhou922 commented May 31, 2021

openapi-workflow-bot bot commented May 31, 2021

openapi-workflow-bot bot commented May 31, 2021

openapi-pipeline-app bot commented May 31, 2021 •

edited

Loading

openapi-pipeline-app bot commented May 31, 2021 •

edited

Loading

openapi-workflow-bot bot commented May 31, 2021

jhendrixMSFT commented Jun 1, 2021

yifan-zhou922 commented Jun 2, 2021

lmazuel Jun 2, 2021

yifan-zhou922 Jun 3, 2021

lmazuel Jun 2, 2021

yifan-zhou922 Jun 3, 2021

Add Browse API to Purview.Catalog #14602

Add Browse API to Purview.Catalog #14602

Conversation

yifan-zhou922 commented May 31, 2021

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented May 31, 2021

openapi-workflow-bot bot commented May 31, 2021

openapi-pipeline-app bot commented May 31, 2021 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented May 31, 2021 • edited Loading

openapi-workflow-bot bot commented May 31, 2021

jhendrixMSFT commented Jun 1, 2021

yifan-zhou922 commented Jun 2, 2021

lmazuel Jun 2, 2021

Choose a reason for hiding this comment

yifan-zhou922 Jun 3, 2021

Choose a reason for hiding this comment

lmazuel Jun 2, 2021

Choose a reason for hiding this comment

yifan-zhou922 Jun 3, 2021

Choose a reason for hiding this comment

openapi-pipeline-app bot commented May 31, 2021 •

edited

Loading

openapi-pipeline-app bot commented May 31, 2021 •

edited

Loading