Struct OpenApiMethodSpec 

pub struct OpenApiMethodSpec {
    pub method_name: String,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub parameters: Option<Value>,
    pub result: Option<Value>,
    pub errors: Vec<OpenApiError>,
    pub tags: Vec<String>,
    pub examples: Vec<OpenApiExample>,
}

OpenAPI specification for a single JSON-RPC method

Fields

method_name: String

summary: Option<String>

description: Option<String>

parameters: Option<Value>

result: Option<Value>

errors: Vec<OpenApiError>

tags: Vec<String>

examples: Vec<OpenApiExample>

Implementations

impl OpenApiMethodSpec

pub fn new(method_name: impl Into<String>) -> Self

Create a new OpenAPI method specification

pub fn with_summary(self, summary: impl Into<String>) -> Self

Add a summary

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

Add a description

pub fn with_parameters(self, params: Value) -> Self

Add parameter schema

pub fn with_result(self, result: Value) -> Self

Add result schema

pub fn with_error(self, error: OpenApiError) -> Self

Add an error specification

pub fn with_tag(self, tag: impl Into<String>) -> Self

Add a tag

pub fn with_example(self, example: OpenApiExample) -> Self

Add an example

Trait Implementations

impl Clone for OpenApiMethodSpec

fn clone(&self) -> OpenApiMethodSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiMethodSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpenApiMethodSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OpenApiMethodSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.