APIAgent
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + implementation | No | const | No | - | Implementation |
| + title | No | string | No | - | Title |
| + root_call_url | No | string | No | - | Root Call Url |
| + open_api_location | No | string | No | - | Open Api Location |
| + operations_to_expose | No | array | No | - | Operations To Expose |
| - extra_header_params | No | object | No | - | Extra Header Params |
| - extra_query_params | No | object | No | - | Extra Query Params |
| - max_response_size | No | integer | No | - | Max Response Size |
1. Property implementation
Title: Implementation
| Type | const |
| Required | Yes |
Specific value: "APIAgent"
2. Property title
Title: Title
| Type | string |
| Required | Yes |
Description: Title of the API
3. Property root_call_url
Title: Root Call Url
| Type | string |
| Required | Yes |
Description: Root URL of the API to call
4. Property open_api_location
Title: Open Api Location
| Type | string |
| Required | Yes |
Description: Location of the OpenAPI schema
5. Property operations_to_expose
Title: Operations To Expose
| Type | array |
| Required | Yes |
Description: Operations to expose
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| Operation | - |
5.1. Operation
| Type | object |
| Required | No |
| Additional properties | [Any type: allowed] |
| Defined in | #/$defs/Operation |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + name | No | string | No | - | Name |
| - description | No | string | No | - | Description |
| + path | No | string | No | - | Path |
| + method | No | string | No | - | Method |
| - result_filters | No | array of string | No | - | Result Filters |
5.1.1. Property name
Title: Name
| Type | string |
| Required | Yes |
Description: Name of the operation
5.1.2. Property description
Title: Description
| Type | string |
| Required | No |
| Default | null |
Description: Description of the operation
5.1.3. Property path
Title: Path
| Type | string |
| Required | Yes |
Description: Path of the operation. Must match exactly including path parameters
5.1.4. Property method
Title: Method
| Type | string |
| Required | Yes |
Description: HTTP method of the operation. get and post are supported
5.1.5. Property result_filters
Title: Result Filters
| Type | array of string |
| Required | No |
| Default | null |
Description: Filters to apply to the result of the operation per json ref spec
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| result_filters items | - |
5.1.5.1. result_filters items
| Type | string |
| Required | No |
6. Property extra_header_params
Title: Extra Header Params
| Type | object |
| Required | No |
| 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
| Type | object |
| Required | No |
| 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)
8. Property max_response_size
Title: Max Response Size
| Type | integer |
| Required | No |
| Default | 51200 |
Description: Maximum size of response content to allow. If the response is larger than this, an error will be raised. Default is 50k