search

wjohnson / pyapacheatlas

A python package to help work with the apache atlas REST APIs
https://wjohnson.github.io/pyapacheatlas-docs/latest/
MIT License
170 stars 96 forks source link

Show API definitions as assets by importing OpenAPI or Swagger files #268

Open jugi92 opened 10 months ago

jugi92 commented 10 months ago

Describe the feature Show API definitions as assets by importing OpenAPI or Swagger files

Detailed Example For example on the following page you can find a Swagger / OpenAPI definition of an API. It would be nice if this SDK could support loading this document as an asset into Purview. A lot of enterprises do offer APIs and treating them similar to data assets would make it easier for data users to find what they are looking for.

Issues that this feature solves

Suggested Implementation Somehow using the JSON Reader and parsing the OpenAPI JSON definition somehow in a smart way?

Additional context It might be challenging as OpenAPI definition could be recursive, i.e. calling itself. Those edge cases could be ignored in the beginning. https://feedback.azure.com/d365community/idea/4b7b7046-e047-ee11-a81c-0022484c92b1 Also posted here but not yet announced for roadmap of Purview.

wjohnson commented 10 months ago

@jugi92 this is a great idea for a custom connector! I've added a help wanted and samlpe tag as I think this is something the community could contribute.

I agree, it would be very important to limit / define what part of OpenAPI this would support but a non-recursive version and a typedef would be a huge help!