1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
use super::RepoHandler;
use crate::Result;
/// A client to GitHub's repository dispatches API.
///
/// Created with [`RepoHandler::dispatches`].
///
/// See also: [GitHub API Documentation](https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#create-a-repository-dispatch-event)
pub struct RepoDispatchesHandler<'octo, 'r> {
handler: &'r RepoHandler<'octo>,
}
impl<'octo, 'r> RepoDispatchesHandler<'octo, 'r> {
pub(crate) fn new(handler: &'r RepoHandler<'octo>) -> Self {
Self { handler }
}
/// Creates a [`CreateDispatchBuilder`] to trigger a `repository_dispatch` webhook event.
///
/// See: [GitHub API Documentation](https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#create-a-repository-dispatch-event)
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// octocrab.repos("owner", "repo")
/// .dispatches()
/// .create("on-demand-test")
/// .client_payload(serde_json::json!({"unit": false, "integration": true}))
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn create(&self, event_type: impl Into<String>) -> CreateDispatchBuilder<'octo, 'r> {
CreateDispatchBuilder::new(self.handler, event_type.into())
}
}
/// A builder pattern struct for triggering a repository dispatch event.
///
/// Created by [`RepoDispatchesHandler::create`], [`RepoHandler::create_dispatch`], or [`RepoHandler::dispatch`].
#[derive(serde::Serialize)]
pub struct CreateDispatchBuilder<'octo, 'r> {
#[serde(skip)]
handler: &'r RepoHandler<'octo>,
event_type: String,
#[serde(skip_serializing_if = "Option::is_none")]
client_payload: Option<serde_json::Value>,
}
impl<'octo, 'r> CreateDispatchBuilder<'octo, 'r> {
pub(crate) fn new(handler: &'r RepoHandler<'octo>, event_type: String) -> Self {
Self {
handler,
event_type,
client_payload: None,
}
}
/// An optional JSON payload with extra information about the webhook event.
///
/// The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB.
pub fn client_payload(mut self, client_payload: impl Into<serde_json::Value>) -> Self {
self.client_payload = Some(client_payload.into());
self
}
/// Sends the actual request.
pub async fn send(self) -> Result<()> {
let route = format!("/{}/dispatches", self.handler.repo);
let response = self.handler.crab._post(route, Some(&self)).await?;
if response.status() != http::StatusCode::NO_CONTENT {
return Err(crate::map_github_error(response).await.unwrap_err());
}
Ok(())
}
}