tailscale-rest 1.3.2

Typed client for the Tailscale control-plane REST API v2
Documentation 
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92

//! Webhook endpoints, and the events they subscribe to.

use crate::Secret;
use crate::model;
use crate::models::KnownValues;

/// The destinations whose message format the description knows.
///
/// An endpoint with none of these gets Tailscale's own JSON shape, which the
/// API spells as the empty string rather than by omitting the field.
pub const PROVIDER_TYPES: &[&str] = &["slack", "mattermost", "googlechat", "discord"];

/// The events a webhook can subscribe to.
pub const SUBSCRIPTIONS: &[&str] = &[
    "nodeCreated",
    "nodeNeedsApproval",
    "nodeApproved",
    "nodeKeyExpiringInOneDay",
    "nodeKeyExpired",
    "nodeDeleted",
    "nodeSigned",
    "nodeNeedsSignature",
    "policyUpdate",
    "userCreated",
    "userNeedsApproval",
    "userSuspended",
    "userRestored",
    "userDeleted",
    "userApproved",
    "userRoleUpdated",
    "subnetIPForwardingNotEnabled",
    "exitNodeIPForwardingNotEnabled",
];

/// Four rows for two lists: the description declares `providerType` and
/// `subscriptions` both inline on `Webhook` and again as schemas of their own,
/// and the drift test wants every path it walks accounted for.
pub const KNOWN_VALUES: &[KnownValues] = &[
    ("Webhook.providerType", PROVIDER_TYPES),
    ("providerType", PROVIDER_TYPES),
    ("Webhook.subscriptions[]", SUBSCRIPTIONS),
    ("subscriptions[]", SUBSCRIPTIONS),
];

model! {
    /// An endpoint Tailscale posts events to.
    Webhook {
        endpoint_id: "endpointId" => String,
        /// Where the `POST` goes.
        endpoint_url: "endpointUrl" => String,
        /// One of [`PROVIDER_TYPES`], or the empty string for Tailscale's own
        /// message shape.
        provider_type: "providerType" => String,
        /// Blank where the endpoint was created by an OAuth client rather than
        /// by a person.
        creator_login_name: "creatorLoginName" => String,
        created: "created" => String,
        last_modified: "lastModified" => String,
        /// Any of [`SUBSCRIPTIONS`].
        subscriptions: "subscriptions" => Vec<String>,
        /// Signs the `Tailscale-Webhook-Signature` header, so a receiver can
        /// tell a real delivery from a forged one. Sent only when the endpoint
        /// is created and when the secret is rotated.
        secret: "secret" => Secret,
    }

    // -----------------------------------------------------------------------
    // The shapes the routes carry.
    // -----------------------------------------------------------------------

    /// Every webhook endpoint the tailnet posts to.
    WebhookList as "GET /tailnet/{tailnet}/webhooks 200" {
        webhooks: "webhooks" => Vec<Webhook>,
    }

    /// What creating an endpoint sends.
    CreateWebhookRequest as "POST /tailnet/{tailnet}/webhooks body" {
        /// Where the `POST` goes. Required.
        endpoint_url: "endpointUrl" => String,
        /// One of [`PROVIDER_TYPES`], which shapes the payload for a receiver
        /// that expects its own format. Omit for Tailscale's own shape.
        provider_type: "providerType" => String,
        /// Which events to send. Any of [`SUBSCRIPTIONS`]. Required.
        subscriptions: "subscriptions" => Vec<String>,
    }

    /// What changing one sends, which is the subscriptions and nothing else:
    /// the URL and the provider cannot be changed after creation.
    UpdateWebhookRequest as "PATCH /webhooks/{endpointId} body" {
        subscriptions: "subscriptions" => Vec<String>,
    }
}