Skip to content

Commit 6ca52f2

Browse files
committed
Add some docs
1 parent 92f14b3 commit 6ca52f2

File tree

1 file changed

+14
-4
lines changed
  • crates/stackable-webhook/src

1 file changed

+14
-4
lines changed

crates/stackable-webhook/src/lib.rs

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
//! Utility types and functions to easily create ready-to-use webhook servers which can handle
2+
//! different tasks. All webhook servers use HTTPS by default.
3+
//!
4+
//! Currently the following webhooks are supported:
5+
//!
6+
//! * CRD conversion webhooks: [`ConversionWebhook`](`webhooks::ConversionWebhook`)
7+
//! * Mutating webhooks: [`MutatingWebhook`](`webhooks::MutatingWebhook`)
8+
//! * In the future validating webhooks wil be added
9+
//!
10+
//! This library is fully compatible with the [`tracing`] crate and emits debug level tracing data.
11+
//!
12+
//! For usage please look at the [`WebhookServer`] docs as well as the specific [`Webhook`] you are
13+
//! using.
114
use std::net::{IpAddr, Ipv4Addr, SocketAddr};
215

316
use ::x509_cert::Certificate;
@@ -93,10 +106,7 @@ impl WebhookServer {
93106
pub const DEFAULT_SOCKET_ADDRESS: SocketAddr =
94107
SocketAddr::new(Self::DEFAULT_LISTEN_ADDRESS, Self::DEFAULT_HTTPS_PORT);
95108

96-
/// Creates a new webhook server with the given config and list of webhooks.
97-
///
98-
/// Currently the webhooks [`ConversionWebhook`](servers::ConversionWebhook) and
99-
/// [`MutatingWebhook`](servers::MutatingWebhook) are implemented.
109+
/// Creates a new webhook server with the given config and list of [`Webhook`]s.
100110
///
101111
/// Please read their documentation for details.
102112
pub async fn new(

0 commit comments

Comments
 (0)