Struct Webhook 

pub struct Webhook {
    pub summary: Option<String>,
    pub description: Option<String>,
    pub operations: HashMap<String, WebhookOperation>,
}

Webhook definition for OpenAPI 3.1

A webhook describes an HTTP callback that your API will call when a specific event occurs.

Fields

summary: Option<String>

Summary of the webhook

description: Option<String>

Detailed description of the webhook

operations: HashMap<String, WebhookOperation>

HTTP methods for the webhook (typically POST)

Implementations

impl Webhook

pub fn new() -> Self

Create a new webhook

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

Create a webhook with a summary

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 post(self, operation: WebhookOperation) -> Self

Add a POST operation

pub fn get(self, operation: WebhookOperation) -> Self

Add a GET operation

pub fn put(self, operation: WebhookOperation) -> Self

Add a PUT operation

pub fn delete(self, operation: WebhookOperation) -> Self

Add a DELETE operation

pub fn operation(self, method: impl Into<String>, op: WebhookOperation) -> Self

Add an operation with a specific HTTP method

Trait Implementations

impl Clone for Webhook

fn clone(&self) -> Webhook

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Webhook

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

Formats the value using the given formatter.

impl Default for Webhook

fn default() -> Webhook

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Webhook

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Webhook

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

where __S: Serializer,

Serialize this value into the given Serde serializer.