Struct OpenRpc

pub struct OpenRpc {
    pub openrpc: String,
    pub info: Info,
    pub servers: Vec<Server>,
    pub methods: Vec<RefOr<Method>>,
    pub components: Option<Components>,
    pub external_docs: Option<ExternalDocumentation>,
}

Represents an OpenRPC document.

Fields

openrpc: String

The semantic version number of the OpenRPC Specification version that the OpenRPC document uses.

This field should be used by tooling specifications and clients to interpret the OpenRPC document.

info: Info

Provides metadata about the API.

This metadata may be used by tooling as required.

servers: 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 with a url value of localhost. This is taken care of by the open-rpc crate.

methods: Vec<RefOr<Method>>

The available methods for the API. While this field is required, it is legal to leave it empty.

components: Option<Components>

Holds various schemas for the specification.

external_docs: Option<ExternalDocumentation>

Contains additional documentation.

Implementations

impl OpenRpc

pub fn get_schema(&self, reference: &str) -> Option<&Schema>

Returns the Method with the given path reference.

Examples

let path = "#/components/schemas/MY_SCHEMA";
let schema = openrpc.get_schema(path).unwrap();

pub fn get_error(&self, reference: &str) -> Option<&Error>

Returns the Error with the given path reference.

Examples

let path = "#/components/errors/MY_ERROR";
let schema = openrpc.get_schema(path).unwrap();

pub fn get_content_descriptor( &self, reference: &str, ) -> Option<&ContentDescriptor>

Returns the ContentDescriptor with the given path reference.

Examples

let path = "#/components/errors/MY_ERROR";
let schema = openrpc.get_schema(path).unwrap();

Trait Implementations

impl Clone for OpenRpc

fn clone(&self) -> OpenRpc

Returns a duplicate 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<'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 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.