ADK for TypeScript: API Reference
    Preparing search index...

    Function createRestApiTool

    • Builds a RestApiTool from a parsed operation.

      Parameters

      • parsed: ParsedOperationInput

        The operation, with the parameters already parsed when the caller has them.

      • options: {
            credentialKey?: string;
            headerProvider?: (context: ReadonlyContext) => Record<string, string>;
            preservePropertyNames?: boolean;
            unconstrainedObjectBodyAsParameter?: boolean;
        } = {}

        Options forwarded to the tool and to its operation parser.

        • OptionalcredentialKey?: string
        • OptionalheaderProvider?: (context: ReadonlyContext) => Record<string, string>
        • OptionalpreservePropertyNames?: boolean
        • OptionalunconstrainedObjectBodyAsParameter?: boolean

          Emits a whole-body parameter for unconstrained object schemas. Will be removed in a future release.

      Returns RestApiTool

      The tool for that operation.