Struct FieldOpenApi

pub struct FieldOpenApi {
    pub name: String,
    pub description: String,
    pub example: String,
    pub pattern: String,
    pub min_length: i32,
    pub max_length: i32,
    pub min_items: i32,
    pub max_items: i32,
    pub required: bool,
    pub identifier: bool,
    pub format: String,
}

FieldOpenAPI is a message used to annotate fields within gRPC message types with additional OpenAPI-specific metadata. This includes field descriptions, examples, validation patterns, length constraints, and other properties.

Fields

name: String

Used for renaming field in OpenAPI schema.

description: String

Description of the field. Defaults to the field name.

example: String

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

pattern: String

Regex pattern the field value should match.

min_length: i32

Minimum length for string fields. Defaults to 1.

max_length: i32

Maximum length for string fields. Defaults to 4096.

min_items: i32

Minimum number of items for repeated fields. Defaults to 1.

max_items: i32

Maximum number of items for repeated fields. Defaults to 4096.

required: bool

Indicates if the field is required.

identifier: bool

Indicates if the field is an identifier.

format: String

Format of the field.

Trait Implementations

impl Clone for FieldOpenApi

fn clone(&self) -> FieldOpenApi

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldOpenApi

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

Formats the value using the given formatter.

impl Default for FieldOpenApi

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FieldOpenApi

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for FieldOpenApi

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 FieldOpenApi

fn eq(&self, other: &FieldOpenApi) -> 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 FieldOpenApi

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 FieldOpenApi