Connect OpenAPI with Bold Data Hub

The Bold Data Hub OpenAPI connector fetches data from OpenAPI 3.x documents and loads it into Bold Reports^®.

Which OpenAPI features are supported?

The Bold Data Hub OpenAPI connector supports the following OpenAPI features:

All HTTP methods are supported.
JSON and form bodies, path and query parameters are accepted.
File uploads can be done with multipart/form-data bodies.
Supported data types include float, string, int, date, datetime, string enums, and custom schemas or lists containing any of those.
Responses can be in html/text or application/json format containing any of the mentioned types.
Basic or Bearer Authentication is not supported.

Connection Properties

The OpenAPI connector in Bold Data Hub reads the following properties from the config section of a YAML file:

        ymlURL:
        ymlPath:

Example Configuration

The following Bold Data Hub YAML template shows a complete OpenAPI extractor configuration:

version: 1
encrypt_credentials: false
plugins:
  extractors:
    - name: OpenAPI
      connectorname: OpenAPI
      config:
        ymlURL:
        ymlPath:
      select:
        - tablename

How do I connect OpenAPI in Bold Data Hub?

You connect an OpenAPI document by creating a pipeline in Bold Data Hub and adding the OpenAPI template to it.

Click the Data Hub icon on the Navigation Pane.
Click Add Pipeline and enter a name for the new pipeline.
Select the newly created pipeline and add the OpenAPI template.
Update the URL and path in the template.
Click Save and choose the destination to save the pipeline.

How do I schedule the OpenAPI pipeline?

You schedule the OpenAPI pipeline in Bold Data Hub from the schedules tab, or you run it on demand.

To configure interval-based scheduling, click the schedules tab, select the created pipeline, click the schedule icon, and configure the schedule.
For an on-demand refresh, click the Run Now button.
Check the schedule history with the history option and the logs.
Click Logs to see whether the run is completed and the data source is created in Bold Reports^®.
Click the Edit DataSource option to view the created tables.