• Reference
  • Nodes
  • Resources
  • OpenAPI

OpenAPI Resource

The OpenAPI Resource (previously known as Swagger) makes it easy to integration with an OpenAPI-compliant RESTful HTTP API.

Properties

Environment Profiles

Propprofiles
Typearray
Default[ { 'definitionUrl': 'https://', 'specContent': '', 'environment': '' } ]

The profiles configured for this resource in an environment

Environment Profile

Propprofiles[]
Typeobject

A profile of this resource for an environment

Definition URL

Propprofiles[].definitionUrl
Typestring

The URL to the OpenAPI specification of your API.

Spec Content

Propprofiles[].specContent
Typestring

The OpenAPI specification for your API.

Environment

Propprofiles[].environment
Typestring

The name of the environment with which this profile is associated

Actions

Perform OpenAPI Request

Performs an API call using the OpenAPI definition.

ParameterTypeDefault
pathstringundefined
bodystringundefined
headersarrayundefined
methodHTTPMethodTypes ("GET" | "POST" | "PUT" | "DELETE" | "OPTIONS")GET
Last updated on November 1, 2022