Crate open_rpc

Source
Expand description

Defines the types defined by the [OpenRPC] specification.

OpenRPC

Structs§

ArrayLiteral
The constraints that may be applied to an array literal schema.
Components
Holds a set of reusable objects for different aspects of the OpenRPC document.
Contact
Contact information for the exposed API.
ContentDescriptor
Content descriptors are that do just as they suggest - describe content. They are reusable ways of describing either parameters or results.
Error
An application-level error.
ExampleObject
Defines an example that is intended to match a Schema of a given ContentDescriptor.
ExamplePairing
A set of example parameters and a result.
ExternalDocumentation
Allows referencing an external resource for extended documentation.
Info
Provides metadata about the API.
IntegerLiteral
The constraints that may be applied to an integer literal schema.
License
License information for the exposed API.
Link
Represents a possible design-time link for a result.
Method
Describes the interface for the given method name.
NumberLiteral
The constraints that may be applied to a number literal schema.
ObjectLiteral
The constraints that may be applied to an object literal schema.
OpenRpc
Represents an OpenRPC document.
RuntimeExpression
Runtime expressions allow the user to define an expression which will evaluate to a string once the desired value(s) are known.
Schema
Allows the definition of input and output data types.
Server
A server.
ServerVariable
An object representing a Server Variable for server URL template substitution.
StringLiteral
The constraints that may be applied to an string literal schema.
Tag
Adds metadata to a single tag that is used by the Method Object.

Enums§

ExampleValue
The example value of an ExampleObject.
LinkParams
The content of the params field of a Link.
Literal
A literal value.
ParamStructure
A possible value for the param_structure field of Method.
RefOr
Either a reference or an inline object.
SchemaContents
The content of a schema.
StringFormat
A string format.