API Reference wardrik_rest v#0.1.0-rc.1

Copy Markdown

Modules

Tools for agents from an HTTP API's description: one tool per operation, with the API's own sign-in and keys.

An API loaded for agents: the operations offered from its description, where it's reached, and where each credential comes from.

Makes one call to an operation for an agent.

Reads Google Discovery documents, the format Google describes its APIs in.

Turns Discovery schemas into JSON Schema types for WardrikRest.Spec.

Reads OpenAPI 3.0 and 3.1 documents, in JSON or YAML.

Turns OpenAPI 3.0 and 3.1 schemas into JSON Schema for WardrikRest.Spec.

One operation of an API, which becomes one tool.

One argument of an operation: part of its path, its query, a field of its body, the whole body, or a header.

Reads an API's description into a WardrikRest.Spec.

Fits an operation's arguments into a size budget, as the JSON Schema of its tool.

What a WardrikRest.Reader reads from an API's description: its operations and the ways it takes credentials.

Raised when a call fails in a way that a retry may fix.