Skip to main content

CommandInfo

aperture_cli::agent

Struct CommandInfo

pub struct CommandInfo {Show 19 fields
    pub name: String,
    pub method: String,
    pub path: String,
    pub description: Option<String>,
    pub summary: Option<String>,
    pub operation_id: String,
    pub parameters: Vec<ParameterInfo>,
    pub request_body: Option<RequestBodyInfo>,
    pub security_requirements: Vec<String>,
    pub tags: Vec<String>,
    pub original_tags: Vec<String>,
    pub deprecated: bool,
    pub external_docs_url: Option<String>,
    pub response_schema: Option<ResponseSchemaInfo>,
    pub display_group: Option<String>,
    pub display_name: Option<String>,
    pub aliases: Vec<String>,
    pub hidden: bool,
    pub pagination: PaginationManifestInfo,
}

Fields§

§name: String

Command name (kebab-case operation ID)

§method: String

HTTP method

§path: String

API path with parameters

§description: Option<String>

Operation description

§summary: Option<String>

Operation summary

§operation_id: String

Operation ID from the OpenAPI spec

§parameters: Vec<ParameterInfo>

Parameters for this operation

§request_body: Option<RequestBodyInfo>

Request body information if applicable

§security_requirements: Vec<String>

Security requirements for this operation

§tags: Vec<String>

Tags associated with this operation (kebab-case)

§original_tags: Vec<String>

Original tag names from the OpenAPI spec (before kebab-case conversion)

§deprecated: bool

Whether this operation is deprecated

§external_docs_url: Option<String>

External documentation URL

§response_schema: Option<ResponseSchemaInfo>

Response schema for successful responses (200/201/204)

§display_group: Option<String>

Display name override for the command group (from command mapping)

§display_name: Option<String>

Display name override for the subcommand (from command mapping)

§aliases: Vec<String>

Additional subcommand aliases (from command mapping)

§hidden: bool

Whether this command is hidden from help output (from command mapping)

§pagination: PaginationManifestInfo

Pagination capability for this operation

Trait Implementations§

impl Debug for CommandInfo

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for CommandInfo

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 CommandInfo

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 CommandInfo

impl RefUnwindSafe for CommandInfo

impl Send for CommandInfo

impl Sync for CommandInfo

impl Unpin for CommandInfo

impl UnsafeUnpin for CommandInfo

impl UnwindSafe for CommandInfo

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> 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, 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<V, T> VZip<V> for T
where 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>,

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>,

impl<T> ErasedDestructor for T
where T: 'static,