Skip to main content

OperationInfo

openapi_to_rust::analysis

Struct OperationInfo

pub struct OperationInfo {
    pub operation_id: String,
    pub method: String,
    pub path: String,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub request_body: Option<RequestBodyContent>,
    pub request_body_required: bool,
    pub response_schemas: BTreeMap<String, String>,
    pub parameters: Vec<ParameterInfo>,
    pub supports_streaming: bool,
    pub stream_parameter: Option<String>,
    pub tags: Vec<String>,
}

Expand description

Information about an OpenAPI operation

Fields§

§operation_id: String

Operation ID

§method: String

HTTP method (GET, POST, etc.)

§path: String

Path template

§summary: Option<String>

Short summary from OpenAPI spec

§description: Option<String>

Longer description from OpenAPI spec

§request_body: Option<RequestBodyContent>

Request body content type and schema (if any)

§request_body_required: bool

Whether requestBody.required was true. Drives whether the generated method takes a Body argument or Option<Body> (T11).

§response_schemas: BTreeMap<String, String>

Response schemas by status code

§parameters: Vec<ParameterInfo>

Parameters (path, query, header)

§supports_streaming: bool

Whether this operation supports streaming

§stream_parameter: Option<String>

Stream parameter name if applicable

§tags: Vec<String>

Tags declared on the operation. Empty when the spec sets none. Used by the server codegen selector grammar (e.g. tag:Chat) and by openapi-to-rust server list for grouping.

Trait Implementations§

impl Clone for OperationInfo

fn clone(&self) -> OperationInfo

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for OperationInfo

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

Formats the value using the given formatter. Read more

impl Default for OperationInfo

fn default() -> OperationInfo

Returns the “default value” for a type. Read more

impl From<&OperationInfo> for OperationSummary

fn from(op: &OperationInfo) -> Self

Converts to this type from the input type.

impl Serialize for OperationInfo

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl Freeze for OperationInfo

impl RefUnwindSafe for OperationInfo

impl Send for OperationInfo

impl Sync for OperationInfo

impl Unpin for OperationInfo

impl UnsafeUnpin for OperationInfo

impl UnwindSafe for OperationInfo

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

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

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more