Export OpenAPI Definitions v1

Export OpenAPI for v1 Runtime Workflows that have an HTTP API Binding.

1. Open the Workflows screen.
2. Select one or more v1 Runtime Workflows.
3. Open the download menu.
4. Click Download OpenAPI definition.
5. Choose the Environment and OpenAPI version.

You can also request the API-key-filtered definition from GET https://{environment-hostname}/openapi.yml?runtimeVersion=1.

Improve the definition

• Add a useful Workflow description.
• Keep Variable Bar interface Properties strongly typed.
• Add clear Notes to request and response Properties.
• Add representative samples to FgRequestBody, FgResponseBody, FgRequestHeaders, and FgResponseHeaders when they define the interface.

See OpenAPI Definitions via API and API.