Skip to main content

Operation

barbacane_compiler::spec_parser::model

Struct Operation

pub struct Operation {Show 15 fields
    pub path: String,
    pub method: String,
    pub operation_id: Option<String>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub parameters: Vec<Parameter>,
    pub request_body: Option<RequestBody>,
    pub dispatch: Option<DispatchConfig>,
    pub middlewares: Option<Vec<MiddlewareConfig>>,
    pub deprecated: bool,
    pub sunset: Option<String>,
    pub extensions: BTreeMap<String, Value>,
    pub messages: Vec<Message>,
    pub bindings: BTreeMap<String, Value>,
    pub responses: BTreeMap<String, ResponseContent>,
}

Expand description

A single API operation (path + method for OpenAPI, channel + action for AsyncAPI).

Fields§

§path: String

The path template (OpenAPI: “/users/{id}”, AsyncAPI: channel address).

§method: String

The HTTP method (OpenAPI: “GET”, AsyncAPI: “SEND”/“RECEIVE”).

§operation_id: Option<String>

The operationId, if present.

§summary: Option<String>

The operation summary (short description for MCP tool name).

§description: Option<String>

The operation description (detailed description for MCP tool).

§parameters: Vec<Parameter>

Path/channel parameters defined on this operation.

§request_body: Option<RequestBody>

Request body definition (OpenAPI: requestBody, AsyncAPI: message payload for SEND).

§dispatch: Option<DispatchConfig>

The dispatcher configuration from x-barbacane-dispatch.

§middlewares: Option<Vec<MiddlewareConfig>>

Operation-level middlewares (replaces global chain if present).

§deprecated: bool

Whether this operation is deprecated (OpenAPI deprecated field).

§sunset: Option<String>

Sunset date for deprecated operations (from x-sunset per RFC 8594). Format: HTTP-date per RFC 9110 (e.g., “Sat, 31 Dec 2024 23:59:59 GMT”).

§extensions: BTreeMap<String, Value>

Operation-level x-barbacane-* extensions.

§messages: Vec<Message>

AsyncAPI messages (for async operations only).

§bindings: BTreeMap<String, Value>

Protocol bindings (AsyncAPI: kafka, nats, mqtt, amqp, ws).

§responses: BTreeMap<String, ResponseContent>

Response definitions keyed by status code (e.g., “200”, “201”).

Trait Implementations§

impl Clone for Operation

fn clone(&self) -> Operation

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Operation

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Operation

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for Operation

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 Operation

impl RefUnwindSafe for Operation

impl Send for Operation

impl Sync for Operation

impl Unpin for Operation

impl UnsafeUnpin for Operation

impl UnwindSafe for Operation

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> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,