Skip to content

ApiLogicUnit

PropertyPatternTypeDeprecatedDefinitionTitle/Description
- implementationNoconstNo-ApiLogicUnit
+ titleNostringNo-Title
+ root_call_urlNostringNo-Root Call Url
+ open_api_locationNostringNo-Open Api Location
+ operations_to_exposeNoarrayNo-Operations To Expose
- extra_header_paramsNoobjectNo-Extra Header Params
- extra_query_paramsNoobjectNo-Extra Query Params

1. Property implementation

Typeconst
RequiredNo

Description: ApiLogicUnit

Specific value: "ApiLogicUnit"

2. Property title

Title: Title

Typestring
RequiredYes

Description: Title of the API

3. Property root_call_url

Title: Root Call Url

Typestring
RequiredYes

Description: Root URL of the API to call

4. Property open_api_location

Title: Open Api Location

Typestring
RequiredYes

Description: Location of the OpenAPI schema

5. Property operations_to_expose

Title: Operations To Expose

Typearray
RequiredYes

Description: Operations to expose

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
Operation-

5.1. Operation

Typeobject
RequiredNo
Additional properties[Any type: allowed]
Defined in#/$defs/Operation
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ nameNostringNo-Name
- descriptionNostringNo-Description
+ pathNostringNo-Path
+ methodNostringNo-Method
- result_filtersNoarray of stringNo-Result Filters

5.1.1. Property name

Title: Name

Typestring
RequiredYes

Description: Name of the operation

5.1.2. Property description

Title: Description

Typestring
RequiredNo
Defaultnull

Description: Description of the operation

5.1.3. Property path

Title: Path

Typestring
RequiredYes

Description: Path of the operation. Must match exactly including path parameters

5.1.4. Property method

Title: Method

Typestring
RequiredYes

Description: HTTP method of the operation. get and post are supported

5.1.5. Property result_filters

Title: Result Filters

Typearray of string
RequiredNo
Defaultnull

Description: Filters to apply to the result of the operation per json ref spec

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
result_filters items-
5.1.5.1. result_filters items
Typestring
RequiredNo

6. Property extra_header_params

Title: Extra Header Params

Typeobject
RequiredNo
Additional properties[Any type: allowed]
Default{}

Description: Extra header parameters to add to every call. This can be a jinja template where the variables in the template are ENV variables (matching case)

7. Property extra_query_params

Title: Extra Query Params

Typeobject
RequiredNo
Additional properties[Any type: allowed]
Default{}

Description: Extra query parameters to add to every call. This can be a jinja template where the variables in the template are ENV variables (matching case)