Struct openrpc_types::OpenRPC

pub struct OpenRPC {
    pub openrpc: Version,
    pub info: Info,
    pub servers: Option<Vec<Server>>,
    pub methods: Vec<ReferenceOr<Method>>,
    pub components: Option<Components>,
    pub external_docs: Option<ExternalDocumentation>,
    pub extensions: SpecificationExtensions,
}

This is the root object of the OpenRPC document. The contents of this object represent a whole OpenRPC document. How this object is constructed or stored is outside the scope of the OpenRPC Specification.

Fields

openrpc: Version

REQUIRED. This string MUST be the semantic version number of the OpenRPC Specification version that the OpenRPC document uses. The openrpc field SHOULD be used by tooling specifications and clients to interpret the OpenRPC document. This is not related to the API info.version string.

info: Info

REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required.

servers: Option<Vec<Server>>

An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of localhost.

methods: Vec<ReferenceOr<Method>>

REQUIRED. The available methods for the API. While it is required, the array may be empty (to handle security filtering, for example).

components: Option<Components>

An element to hold various schemas for the specification.

external_docs: Option<ExternalDocumentation>

Additional external documentation.

extensions: SpecificationExtensions

Trait Implementations

impl Clone for OpenRPC

fn clone(&self) -> OpenRPC

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenRPC

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OpenRPC

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OpenRPC

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OpenRPC

fn eq(&self, other: &OpenRPC) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OpenRPC

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OpenRPC