Struct EndpointSchema 

pub struct EndpointSchema {
    pub name: String,
    pub code: u32,
    pub parameters: Vec<Field>,
    pub returns: Vec<Field>,
    pub stream_response: Option<Type>,
    pub description: String,
    pub json_schema: Value,
    pub roles: Vec<String>,
    pub errors: Vec<EndpointErrorSchema>,
}

EndpointSchema is a struct that represents a single endpoint in the API.

Fields

name: String

The name of the endpoint (e.g. UserListSymbols)

code: u32

The method code of the endpoint (e.g. 10020)

parameters: Vec<Field>

A list of parameters that the endpoint accepts (e.g. “symbol” of type String)

returns: Vec<Field>

A list of fields that the endpoint returns

stream_response: Option<Type>

The type of the stream response (if any)

description: String

A description of the endpoint added by with_description method

json_schema: Value

The JSON schema of the endpoint (Default::default())

roles: Vec<String>

errors: Vec<EndpointErrorSchema>

Public error variants that handlers may return for this endpoint.

Implementations

impl EndpointSchema

pub fn new( name: impl Into<String>, code: u32, parameters: Vec<Field>, returns: Vec<Field>, ) -> Self

Creates a new EndpointSchema with the given name, method code, parameters and returns.

pub fn with_stream_response_type(self, stream_response: Type) -> Self

Adds a stream response type field to the endpoint.

pub fn with_description(self, desc: impl Into<String>) -> Self

Adds a description field to the endpoint.

pub fn with_roles(self, roles: Vec<String>) -> Self

Adds allowed roles to the endpoint.

pub fn with_errors(self, errors: Vec<EndpointErrorSchema>) -> Self

Adds public error variants to the endpoint.

Trait Implementations

impl Clone for EndpointSchema

fn clone(&self) -> EndpointSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointSchema

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

Formats the value using the given formatter.

impl Default for EndpointSchema

fn default() -> EndpointSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EndpointSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EndpointSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.