Skip to main content

OpenAPI Dataset

Overview

OpenAPIDataset is a dataset component responsible for supplying configured OpenAPI specifications to pipelines.

Its role is limited to scoping API definitions and endpoints and passing them to the appropriate pipelines for execution.


Purpose

  • Selects a specific OpenAPI dataset
  • Restricts access to configured API specifications
  • Provides endpoint definitions to pipelines
  • Ensures consistent API scope across agents and workflows

Configuration Contents

The OpenAPIDataset configuration defines which OpenAPI data is exposed to pipelines.

  • Dataset – Unique OpenAPI dataset that contains the API specification(s).

  • document Selection – List of selected API specifications that restrict and secure pipeline access.


Responsibility Scope

What OpenAPIDataset Does

  • Resolves references to configured OpenAPI specifications
  • Supplies API and endpoint context to pipelines
  • Acts as an API definition provider, not an executor
  • Maintains strict separation between API selection and execution logic

Info: OpenAPIDataset is used together with the following pipelines:


Summary

OpenAPIDataset is an API-scoping dataset for OpenAPI-backed workflows.
It strictly controls which API specifications and endpoints are exposed and delegates all execution, orchestration, and response handling logic to pipelines.