Skip to main content

Module schema

Module schema 

Source
Expand description

OpenAPI schema parsing seam — forward stub filled by Plan 03 (OAPI-02). OpenAPI schema parser — the AUTHORITATIVE home of Operation (OAPI-04).

Parses an OpenAPI 3.0/3.1 document (JSON or YAML) into an indexed OpenApiSchema whose Operation values the single-call synthesizer (Plan 03) and the code-mode executor (Plan 04/05) consume. The parser is the producer of Operation, so the canonical struct lives HERE and is re-exported from crate::http (mod.rs) — the type path crate::http::Operation stays stable across every plan (Codex MEDIUM: one home from day one).

§Runtime-optional (D-03)

A spec is OPTIONAL at runtime. OpenApiSchema::parse is never called unless the operator supplies a --spec document; the binary threads the result as an Option<OpenApiSchema>, and a curated-only server (single-call [[tools]] with explicit path/method) boots with None. Contrast the SQL --schema input which is effectively required. The spec, when present, surfaces two ways: (a) verbatim spec text for the code-mode api_schema resource, and (b) parsed Operation values for richer tool synthesis.

Structs§

OpenApiSchema
A parsed OpenAPI document with its Operation values indexed by (path, METHOD) (OAPI-04 / D-03).
Operation
An extracted REST operation backed by an OpenAPI definition.
Parameter
A single OpenAPI operation parameter.

Enums§

ParameterLocation
Where an Operation parameter is carried in the outgoing request.