OpenAPI Function Generator
Overview
You can use this Snap to convert an OpenAPI specification into functions for tool calling.
Format-type Snap
Works in Ultra Tasks
Prerequisites
None.
Limitations and known issues
None.
Snap views
| View | Description | Examples of upstream and downstream Snaps |
|---|---|---|
| Input | This Snap can have none or one document input view. The input can include
tools. If present, the Snap concatenates it with the OpenAPI
function. |
|
| Output | This Snap has exactly one document output view. The output contains a list of
tools, each representing an OpenAPI function with its metadata,
including the function name, description, method, URL, security settings, headers,
and a JSON schema defining the input parameters. |
|
| Error |
Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:
Learn more about Error handling in Pipelines. |
|
Snap settings
- Expression icon (
): Allows using JavaScript
syntax to access SnapLogic Expressions to set field values dynamically (if enabled). If
disabled, you can provide a static value. Learn more. - SnapGPT (
): Generates SnapLogic Expressions
based on natural language using SnapGPT. Learn
more. - Suggestion icon (
): Populates a
list of values dynamically based on your Snap configuration.
You can select only one attribute at a time using the icon.
Type into the field if it supports a comma-separated list of values. - Upload
: Uploads files. Learn more.
| Field / Field set | Type | Description |
|---|---|---|
| Label | String | Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline. Default value: OpenAPI Function Generator Example: Generate API Functions |
| Input type | Dropdown list | Required. Choose the input method for the OpenAPI
specification. Available options are:
Default value: Text editor Example: URL |
| OpenAPI specification | Button |
Appears when you choose Text editor for the Input type field. Required. Click the button to open the text editor for specifying the OpenAPI specification content in JSON or YAML format. |
| OpenAPI specification | String/Expression |
Appears when you choose Input document for the Input type field. Required. Specify the OpenAPI specification content in JSON or YAML format. |
| OpenAPI specification file | String/Expression | Appears when you choose File for the Input type field. Required. Specify the OpenAPI specification file to generate functions. You can also upload the file from your SLDB.Default value: N/A Example: openapi_spec.yaml |
| OpenAPI specification URL | String/Expression | Appears when you choose URL for the Input type field. Required. Specify the OpenAPI specification URL to generate functions.Default value: N/A Example: openapi_spec.yaml |
| Base URL | String/Expression/ Suggestion | Required. Specify the base URL for the OpenAPI
specification. Default value: N/A Example: https://petstore3.swagger.io/api/v3 |
| Preferred content type | String/Expression | Required. Specify the content type in a MIME (Multipurpose Internet Mail Extensions) type format
for the OpenAPI specification. Important: If you do not provide a
content type or if it is not supported, the Snap defaults to the first supported
content type from the specification. Default value: application/json Example: application/yaml |
| Aggregate input | Checkbox/Expression |
Select this checkbox to aggregate the input content into a single output document. When selected, the Snap isn't compatible with Ultra Tasks. Note: This field does not support upstream
values.
Default status: Deselected |
| Snap execution | Dropdown list |
Choose one of the three modes in
which the Snap executes. Available options are:
Default value: Validate & Execute Example: Execute only |