Skip to content

This component is complete and can be used. The interfaces will be supported until the function is removed from the project via the deprecation process. There will be ongoing extensions to this function, but it will be done to ensure backward compatibility as far as possible. If there is a need to break backward compatibility, this will be discussed and reviewed in the community, with a documented timeline.

API Integrator Open Metadata Integration Service (OMIS)

The API Integrator OMIS supports the exchange of data assets and their related schema and connection information between an external API manager and the open metadata ecosystem.

It supports a type of integration connector that is able to create DeployedAPI assets along with its associated API specification (APISchemaType). Optionally, this metadata can be tied to an APIManager.

Figure 1 shows the types of metadata that integrators connectors can create with this integration service.

Figure 1

Figure 1: API metadata supported by the API Integrator OMIS

The structure of an API specification consist of a number of APIOperations which in turn have optional APIParameterLists for the header, request and response. The details of these payloads are described using SchemaAttributes and SchemaTypes.

Figure 2 shows the open metadata types used to represent the metadata created through this service.

Figure 2

Figure 2: API open metadata types supported by the API Integrator OMIS

If an APIManager is defined, any API created is automatically linked to it using the ServerAssetUse relationship. When an APIOperation is created for the API, the service automatically inserts the AssetSchemaType relationship, APISchemaType entity and APIOperations relationship in between the DeployedAPI entity and the APIOperation entity.

Any schema attributes created through this interface will use the APIParameter subtype to allow for find requests that only return schema information for APIs. The schema attributes also use the TypeEmbeddedAttribute classification method for defining the schema type.

This integration service is paired with the Data Manager OMAS.

Raise an issue or comment below