OpenApiTool

import type { OpenApiTool } from "https://googleapis.deno.dev/v1/ces:v1.ts";

A remote API tool defined by an OpenAPI schema.

interface OpenApiTool {

apiAuthentication?: ApiAuthentication;

description?: string;

ignoreUnknownFields?: boolean;

name?: string;

openApiSchema?: string;

serviceDirectoryConfig?: ServiceDirectoryConfig;

tlsConfig?: TlsConfig;

url?: string;

}

§Properties

apiAuthentication?: ApiAuthentication

[src]

Optional. Authentication information required by the API.

description?: string

[src]

Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from operation.description or operation.summary.

ignoreUnknownFields?: boolean

[src]

Optional. If true, the agent will ignore unknown fields in the API response.

name?: string

[src]

Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from operation.operationId.

openApiSchema?: string

[src]

Required. The OpenAPI schema in JSON or YAML format.

serviceDirectoryConfig?: ServiceDirectoryConfig

[src]

Optional. Service Directory configuration.

tlsConfig?: TlsConfig

[src]

Optional. The TLS configuration. Includes the custom server certificates that the client will trust.

url?: string

[src]

Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.