Struct MethodOpenApi

pub struct MethodOpenApi {
    pub resource: bool,
    pub description: String,
    pub request_schema: String,
    pub response_schema: String,
    pub error_responses: HashMap<u32, String>,
    pub http_rule_index: u32,
    pub path_parameter_name: String,
    pub extensions: HashMap<String, String>,
    pub datasource: bool,
}

MethodOpenAPI is a message used to annotate gRPC methods with additional OpenAPI-specific metadata. This includes whether the method operates on a REST resource, its description, request schema, error responses, and the index of the HTTP rule where endpoints is defined.

Fields

resource: bool

Indicates if the method operates on a REST resource.

description: String

Description of the method.

request_schema: String

Schema of the request message. (Used when you want to use different schema than the one that will be generated from method request mesage type).

response_schema: String

Schema of the response message. (Used when you want to use different schema than the one that will be generated from method response mesage type).

error_responses: HashMap<u32, String>

Map of error response codes to descriptions.

http_rule_index: u32

Index of the associated HTTP rule.

path_parameter_name: String

Name of the path parameter used in openapi spec.

extensions: HashMap<String, String>

Map of extensions. Value is a free-form property to include a JSON of this field. This is copied to generated schema. Quotes must be escaped.

datasource: bool

Indicates if the method is a datasource.

Trait Implementations

impl Clone for MethodOpenApi

fn clone(&self) -> MethodOpenApi

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MethodOpenApi

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

Formats the value using the given formatter.

impl Default for MethodOpenApi

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MethodOpenApi

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for MethodOpenApi

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for MethodOpenApi

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for MethodOpenApi

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 MethodOpenApi