Skip to main content

Module model

Module model 

Source
Expand description

The OpenAPI object model.

Data and invariant-preserving constructors, and nothing else. Producing an artifact from this model lives in crate::emit; checking one against the specification lives in crate::validate.

This is the subtree that would become a standalone IR crate if the satellite-crate boundary described in docs/architecture.md is ever drawn.

Modules§

body
The Request Body, Media Type and Encoding Objects.
callback
The Callback Object.
components
The Components Object and its key type.
document
The root OpenAPI Object.
example
The Example Object.
extensions
Specification extensions (x- prefixed fields).
external_docs
The External Documentation Object.
info
The Info, Contact and License Objects.
link
The Link Object.
parameter
The Parameter, Header and Style Objects.
paths
The Paths, Path Item and Operation Objects, and path templating.
reference
The Reference Object, and the “either a reference or the thing” wrapper.
response
The Responses and Response Objects.
schema
The Schema Object: JSON Schema 2020-12 plus the OAS base vocabulary.
security
The Security Scheme, OAuth Flows and Security Requirement Objects.
server
The Server and Server Variable Objects.
tag
The Tag Object.