Struct WebhookOperation 

pub struct WebhookOperation {
    pub tags: Option<Vec<String>>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub external_docs: Option<ExternalDocs>,
    pub operation_id: Option<String>,
    pub request_body: Option<WebhookRequestBody>,
    pub responses: Option<HashMap<String, WebhookResponse>>,
    pub security: Option<Vec<HashMap<String, Vec<String>>>>,
    pub deprecated: Option<bool>,
}

Webhook operation (similar to path operation)

Fields

tags: Option<Vec<String>>

Tags for API documentation

summary: Option<String>

Brief summary

description: Option<String>

Detailed description

external_docs: Option<ExternalDocs>

External documentation

operation_id: Option<String>

Unique operation ID

request_body: Option<WebhookRequestBody>

Request body schema

responses: Option<HashMap<String, WebhookResponse>>

Expected responses from the webhook consumer

security: Option<Vec<HashMap<String, Vec<String>>>>

Security requirements

deprecated: Option<bool>

Whether this operation is deprecated

Implementations

impl WebhookOperation

pub fn new() -> Self

Create a new webhook operation

pub fn summary(self, summary: impl Into<String>) -> Self

Set the summary

pub fn description(self, description: impl Into<String>) -> Self

Set the description

pub fn operation_id(self, id: impl Into<String>) -> Self

Set the operation ID

pub fn tags(self, tags: Vec<String>) -> Self

Add tags

pub fn request_body(self, body: WebhookRequestBody) -> Self

Set the request body

pub fn response( self, status: impl Into<String>, response: WebhookResponse, ) -> Self

Add a response

pub fn deprecated(self) -> Self

Mark as deprecated

Trait Implementations

impl Clone for WebhookOperation

fn clone(&self) -> WebhookOperation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebhookOperation

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

Formats the value using the given formatter.

impl Default for WebhookOperation

fn default() -> WebhookOperation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebhookOperation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WebhookOperation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.