OpenAPI Resource
The OpenAPI Resource (previously known as Swagger) makes it easy to integration with an OpenAPI-compliant (opens in a new tab) RESTful HTTP API.
Properties
Environment Profiles
| Prop | profiles |
|---|---|
| Type | array |
| Default | [ { 'definitionUrl': 'https://', 'specContent': '', 'environment': '' } ] |
The profiles configured for this resource in an environment
Environment Profile
| Prop | profiles[] |
|---|---|
| Type | object |
| Default | undefined |
A profile of this resource for an environment
Definition URL
| Prop | profiles[].definitionUrl |
|---|---|
| Type | string |
| Default | undefined |
The URL to the OpenAPI specification of your API.
Spec Content
| Prop | profiles[].specContent |
|---|---|
| Type | string |
| Default | undefined |
The OpenAPI specification for your API.
Environment
| Prop | profiles[].environment |
|---|---|
| Type | string |
| Default | undefined |
The name of the environment with which this profile is associated
Actions
Perform OpenAPI Request
Performs an API call using the OpenAPI definition.
| Parameter | Type | Default |
|---|---|---|
path | string | undefined |
body | string | undefined |
headers | array | undefined |
method | HTTPMethodTypes ("GET" | "POST" | "PUT" | "DELETE" | "OPTIONS") | GET |