Expand description
Models used by OpenAPI v2.
Structs§
- Api
- OpenAPI v2 (swagger) spec generic over parameter and schema.
- Coder
- Represents the en/decoder for some MIME media range.
- Coders
x-rust-coders
global extension for custom encoders and decoders.- Contact
- Contact object.
- Default
Schema - Default schema if your schema doesn’t have any custom fields.
- Default
Schema Raw - Raw version of schema.
- External
Docs - External Documentation object.
- Header
- Header object.
- Info
- Info object.
- Items
- Items object.
- License
- License object.
- Media
Range - Wrapper for
mime::MediaRange
to supportBTree{Set, Map}
. - Operation
- Operation object.
- Parameter
- Request parameter object.
- Path
Item - Path item object.
- Reference
- Reference object.
- Response
- Response object.
- Security
Scheme - Security Scheme object.
- Tag
- Tag object.
Enums§
- Collection
Format - Possible formats for array values in parameter.
- Data
Type - Supported data types.
- Data
Type Format - Supported data type formats.
- Either
Either
from “either” crate. We can’t use that crate because we don’t want the enum to be tagged during de/serialization.- Http
Method - The HTTP method used for an operation.
- Operation
Protocol - The protocol used for an operation.
- Parameter
In - The location of the parameter.
- Resolvable
- Wrapper for schema. This uses
Arc<RwLock<S>>
for interior mutability and differentiates raw schema from resolved schema (i.e., the one where$ref
references point to the actual schema). - Spec
Format - The format used by spec (JSON/YAML).
- Version
- OpenAPI version.
Statics§
- JSON_
CODER - Default coder for JSON.
- JSON_
MIME - Media range for JSON.
- YAML_
CODER - Default coder for YAML.
- YAML_
MIME - Media range for YAML.
Type Aliases§
- Default
ApiRaw - OpenAPI v2 spec with defaults.
- Default
Operation Raw - Operation with default raw parameter and response.
- Default
Parameter Raw - Parameter with the default raw schema.
- Default
Path Item Raw - Path item with default parameter and response.
- Default
Response Raw - Response with the default raw schema.
- Resolvable
Api - OpenAPI v2 spec which can be traversed and resolved for codegen.
- Resolvable
Operation - Operation that can be traversed and resolved for codegen.
- Resolvable
Parameter - Parameter that can be traversed and resolved for codegen.
- Resolvable
Path Item - Path item that can be traversed and resolved for codegen.
- Resolvable
Response - Response that can be traversed and resolved for codegen.