OpenAPI to Collibra Integration (Python)
Overview
The OpenAPI Specification is a format that helps describe, produce, consume, and visualize RESTful APIs. The aim of this integration is to import the API information such as Endpoints, Status Codes, Data Structures, and Data Elements from an Open API Spec. After a successful import, a user is able to see all the data structures related to their data elements and all of the endpoints related to all of their status codes.
Use cases
This Open API specification integration serves the following use cases, amongst others:
-
Oftentimes, a business has a lot of APIs without having control over what each API does or the relations contained in it. This Open API integration will help give a structured view of all of the APIs and lets the user trace which API Endpoint the Data Structures and Data Elements are related to.
-
In this way, each Collibra user is able to understand all the roles and use cases of all of the APIs via the relation views and attributes. They are also able to keep track of the changes in the APIs.
Elements in Scope
From the received API specification, the application extracts the following fields:
- API name and Description
- List of Server Location URLs
- API Tags
- All API endpoints
- Response codes for each endpoint
- Types of responses for each response code.
- List of all components schemas and component response schemas.
Media
More details
Release Notes
The sorting before import has been removed
Compatibility
- Collibra Data Intelligence Cloud
Dependency
- python 3.11+
License and Usage Requirements
Release History
Release Notes
The issue with the static variable in the code has been fixed, and it has been moved to the config file.
Compatibility
- Collibra Data Intelligence Cloud
Dependency
- python 3.11+
License and Usage Requirements
Release Notes
Initial release:
OpenAPI integration that receives an JSON payload containing an OpenAPI specification, transforms it, and the upserts it to a Collibra environment as assets.
Compatibility
- Collibra Data Intelligence Cloud
Dependency
- python 3.11+
License and Usage Requirements
Release Notes
Initial release:
OpenAPI integration that receives an JSON payload containing an OpenAPI specification, transforms it, and the upserts it to a Collibra environment as assets.
Compatibility
- Collibra Data Intelligence Cloud
Dependency
- python 3.11+
License and Usage Requirements
See existing Q&A in the Collibra Community
Browse discussions with customers who also use this app.
Start a New Topic in the Collibra Community
Collibra-hosted discussions will connect you to other customers who use this app.
The following terms shall apply to the extent you receive the source code to this offering: Notwithstanding the terms of the Binary Code License Agreement under which this integration template is licensed, Collibra grants you, the Licensee, the right to access the source code to the integrated template in order to copy and modify said source code for Licensee’s internal use purposes and solely for the purpose of developing connections and/or integrations with Collibra products and services.
Solely with respect to this integration template, the term “Software,” as defined under the Binary Code License Agreement, shall include the source code version thereof. Except with respect to the foregoing, all remaining terms of the Binary Code License Agreement shall apply to the license of integration template hereunder.
