Struct OpenApiRouteMetadata

Source

pub struct OpenApiRouteMetadata {Show 20 fields
    pub tags: Vec<String>,
    pub operation_id: Option<String>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub parameters: Vec<OpenApiReferenceOr<OpenApiParameter>>,
    pub request_body: Option<OpenApiReferenceOr<OpenApiRequestBody>>,
    pub responses: BTreeMap<String, OpenApiReferenceOr<OpenApiResponse>>,
    pub servers: Vec<OpenApiServer>,
    pub external_docs: Option<OpenApiExternalDocs>,
    pub extensions: BTreeMap<String, Value>,
    pub schema_components: BTreeMap<String, OpenApiSchema>,
    pub response_components: BTreeMap<String, OpenApiResponse>,
    pub parameter_components: BTreeMap<String, OpenApiParameter>,
    pub example_components: BTreeMap<String, OpenApiExample>,
    pub request_body_components: BTreeMap<String, OpenApiRequestBody>,
    pub header_components: BTreeMap<String, OpenApiHeader>,
    pub security_schemes: BTreeMap<String, OpenApiSecurityScheme>,
    pub security: Vec<OpenApiSecurityRequirement>,
    pub deprecated: bool,
    pub hidden: bool,
}

Expand description

Route-level OpenAPI metadata carried by RouteDefinition.

Fields§

§tags: Vec<String>§operation_id: Option<String>§summary: Option<String>§description: Option<String>§parameters: Vec<OpenApiReferenceOr<OpenApiParameter>>§request_body: Option<OpenApiReferenceOr<OpenApiRequestBody>>§responses: BTreeMap<String, OpenApiReferenceOr<OpenApiResponse>>§servers: Vec<OpenApiServer>§external_docs: Option<OpenApiExternalDocs>§extensions: BTreeMap<String, Value>§schema_components: BTreeMap<String, OpenApiSchema>§response_components: BTreeMap<String, OpenApiResponse>§parameter_components: BTreeMap<String, OpenApiParameter>§example_components: BTreeMap<String, OpenApiExample>§request_body_components: BTreeMap<String, OpenApiRequestBody>§header_components: BTreeMap<String, OpenApiHeader>§security_schemes: BTreeMap<String, OpenApiSecurityScheme>§security: Vec<OpenApiSecurityRequirement>§deprecated: bool§hidden: bool

OpenApiRouteMetadata

Struct OpenApiRouteMetadata Copy item path

Fields§

Trait Implementations§

impl Clone for OpenApiRouteMetadata

fn clone(&self) -> OpenApiRouteMetadata

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

impl Debug for OpenApiRouteMetadata

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

impl Default for OpenApiRouteMetadata

fn default() -> OpenApiRouteMetadata

impl PartialEq for OpenApiRouteMetadata

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

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

impl StructuralPartialEq for OpenApiRouteMetadata

Auto Trait Implementations§

impl Freeze for OpenApiRouteMetadata

impl RefUnwindSafe for OpenApiRouteMetadata

impl Send for OpenApiRouteMetadata

impl Sync for OpenApiRouteMetadata

impl Unpin for OpenApiRouteMetadata

impl UnsafeUnpin for OpenApiRouteMetadata

impl UnwindSafe for OpenApiRouteMetadata

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DTwhere ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DTwhere ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FromRef<T> for Twhere T: Clone,

fn from_ref(input: &T) -> T

impl<A, B, T> HttpServerConnExec<A, B> for Twhere B: Body,

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Read<Exclusive, BecauseExclusive> for Twhere T: ?Sized,

impl<T> Same for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

Struct OpenApiRouteMetadata

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T> FromRef<T> for T
where T: Clone,

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

impl<T, U> Into<U> for T
where U: From<T>,

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,