api: notification: add API routes for webhook targets

Copied and adapted from the Gotify ones.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Tested-By: Stefan Hanreich <s.hanreich@proxmox.com>
This commit is contained in:
Lukas Wagner 2024-11-08 15:41:21 +01:00 committed by Thomas Lamprecht
parent 5a52d1f06c
commit aa8f7f6208
2 changed files with 177 additions and 0 deletions

View File

@ -22,6 +22,7 @@ pub mod matchers;
pub mod sendmail;
pub mod smtp;
pub mod targets;
pub mod webhook;
#[sortable]
const SUBDIRS: SubdirMap = &sorted!([
@ -41,6 +42,7 @@ const ENDPOINT_SUBDIRS: SubdirMap = &sorted!([
("gotify", &gotify::ROUTER),
("sendmail", &sendmail::ROUTER),
("smtp", &smtp::ROUTER),
("webhook", &webhook::ROUTER),
]);
const ENDPOINT_ROUTER: Router = Router::new()

View File

@ -0,0 +1,175 @@
use anyhow::Error;
use serde_json::Value;
use proxmox_notify::endpoints::webhook::{
DeleteableWebhookProperty, WebhookConfig, WebhookConfigUpdater,
};
use proxmox_notify::schema::ENTITY_NAME_SCHEMA;
use proxmox_router::{Permission, Router, RpcEnvironment};
use proxmox_schema::api;
use pbs_api_types::{PRIV_SYS_AUDIT, PRIV_SYS_MODIFY, PROXMOX_CONFIG_DIGEST_SCHEMA};
#[api(
protected: true,
input: {
properties: {},
},
returns: {
description: "List of webhook endpoints.",
type: Array,
items: { type: WebhookConfig },
},
access: {
permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_AUDIT, false),
},
)]
/// List all webhook endpoints.
pub fn list_endpoints(
_param: Value,
_rpcenv: &mut dyn RpcEnvironment,
) -> Result<Vec<WebhookConfig>, Error> {
let config = pbs_config::notifications::config()?;
let endpoints = proxmox_notify::api::webhook::get_endpoints(&config)?;
Ok(endpoints)
}
#[api(
protected: true,
input: {
properties: {
name: {
schema: ENTITY_NAME_SCHEMA,
}
},
},
returns: { type: WebhookConfig },
access: {
permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_AUDIT, false),
},
)]
/// Get a webhook endpoint.
pub fn get_endpoint(name: String, rpcenv: &mut dyn RpcEnvironment) -> Result<WebhookConfig, Error> {
let config = pbs_config::notifications::config()?;
let endpoint = proxmox_notify::api::webhook::get_endpoint(&config, &name)?;
rpcenv["digest"] = hex::encode(config.digest()).into();
Ok(endpoint)
}
#[api(
protected: true,
input: {
properties: {
endpoint: {
type: WebhookConfig,
flatten: true,
},
},
},
access: {
permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_MODIFY, false),
},
)]
/// Add a new webhook endpoint.
pub fn add_endpoint(
endpoint: WebhookConfig,
_rpcenv: &mut dyn RpcEnvironment,
) -> Result<(), Error> {
let _lock = pbs_config::notifications::lock_config()?;
let mut config = pbs_config::notifications::config()?;
proxmox_notify::api::webhook::add_endpoint(&mut config, endpoint)?;
pbs_config::notifications::save_config(config)?;
Ok(())
}
#[api(
protected: true,
input: {
properties: {
name: {
schema: ENTITY_NAME_SCHEMA,
},
updater: {
type: WebhookConfigUpdater,
flatten: true,
},
delete: {
description: "List of properties to delete.",
type: Array,
optional: true,
items: {
type: DeleteableWebhookProperty,
}
},
digest: {
optional: true,
schema: PROXMOX_CONFIG_DIGEST_SCHEMA,
},
},
},
access: {
permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_MODIFY, false),
},
)]
/// Update webhook endpoint.
pub fn update_endpoint(
name: String,
updater: WebhookConfigUpdater,
delete: Option<Vec<DeleteableWebhookProperty>>,
digest: Option<String>,
_rpcenv: &mut dyn RpcEnvironment,
) -> Result<(), Error> {
let _lock = pbs_config::notifications::lock_config()?;
let mut config = pbs_config::notifications::config()?;
let digest = digest.map(hex::decode).transpose()?;
proxmox_notify::api::webhook::update_endpoint(
&mut config,
&name,
updater,
delete.as_deref(),
digest.as_deref(),
)?;
pbs_config::notifications::save_config(config)?;
Ok(())
}
#[api(
protected: true,
input: {
properties: {
name: {
schema: ENTITY_NAME_SCHEMA,
}
},
},
access: {
permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_MODIFY, false),
},
)]
/// Delete webhook endpoint.
pub fn delete_endpoint(name: String, _rpcenv: &mut dyn RpcEnvironment) -> Result<(), Error> {
let _lock = pbs_config::notifications::lock_config()?;
let mut config = pbs_config::notifications::config()?;
proxmox_notify::api::webhook::delete_endpoint(&mut config, &name)?;
pbs_config::notifications::save_config(config)?;
Ok(())
}
const ITEM_ROUTER: Router = Router::new()
.get(&API_METHOD_GET_ENDPOINT)
.put(&API_METHOD_UPDATE_ENDPOINT)
.delete(&API_METHOD_DELETE_ENDPOINT);
pub const ROUTER: Router = Router::new()
.get(&API_METHOD_LIST_ENDPOINTS)
.post(&API_METHOD_ADD_ENDPOINT)
.match_all("name", &ITEM_ROUTER);