OpenAPI

OpenAPI fetch data from OpenAPI 3.x documents.

OpenAPI features supported

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

Connection Properties

The config section in a YAML file includes the following properties:

        ymlURL:
        ymlPath:

Example Configuration

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

Configure the Bold Data Hub to connect OpenAPI

1. Click the Data Hub icon on the Navigation Pane.

1. Click Add Pipeline and provide the new pipeline’s name.

1. Select the newly created pipeline and add the OpenAPI template.

1. Update the Url and Path in the template.
2. Click Save and choose the desired destination to save the pipeline.

Schedule Data Hub Job

1. To configure interval-based scheduling, click on the schedules tab and select the created pipeline and click on the schedule icon and configure it.

1. For on-demand refresh, click Run Now button.

1. The Schedule history can be checked using the history option as well as logs.

1. Click on Logs to see if the run is completed and data source is created in Bold Reports^®.

1. Click Edit DataSource Option to view the created tables.