wyrd-spec 0.1.1

Wyrd foundation types: Card envelope, SpecKinds, and pure data contracts.
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
93

//! Wire contract for tenant provisioning on the platform control plane.

use serde::{Deserialize, Serialize};

use crate::DataTenantId;
use crate::auth::{PrincipalId, SecretBearer};
use crate::ids::TenantSlug;

/// Request to provision a new tenant.
#[derive(Debug, Clone, Serialize, Deserialize, schemars::JsonSchema)]
#[cfg_attr(feature = "server", derive(utoipa::ToSchema))]
#[serde(deny_unknown_fields)]
pub struct CreateTenantRequest {
    /// URL-safe tenant identifier, unique across the deployment.
    pub slug: TenantSlug,
    /// Human-readable tenant name.
    pub display_name: String,
}

/// The tenant that was provisioned.
#[derive(Debug, Clone, Serialize, Deserialize, schemars::JsonSchema)]
#[cfg_attr(feature = "server", derive(utoipa::ToSchema))]
pub struct ProvisionedTenant {
    /// Server-assigned tenant isolation key.
    pub id: DataTenantId,
    /// URL-safe tenant identifier.
    pub slug: TenantSlug,
    /// Human-readable tenant name.
    pub display_name: String,
    /// Lifecycle state. `active` once the tenant is usable.
    pub status: String,
}

/// The tenant's administrative principal and its one-time credential.
#[derive(Debug, Serialize, Deserialize, schemars::JsonSchema)]
#[cfg_attr(feature = "server", derive(utoipa::ToSchema))]
pub struct ProvisionedTenantAdmin {
    /// Durable principal id. It survives credential rotation and loss.
    pub principal_id: PrincipalId,
    /// The credential, returned exactly once and never retrievable again.
    #[schemars(with = "String")]
    pub credential: SecretBearer,
}

/// Result of provisioning a tenant.
///
/// Carries the administrative credential exactly once. The server stores only
/// its verifier, so a caller that discards this response must recover through
/// the platform plane rather than by reading it back.
#[derive(Debug, Serialize, Deserialize, schemars::JsonSchema)]
#[cfg_attr(feature = "server", derive(utoipa::ToSchema))]
pub struct CreateTenantResponse {
    /// The provisioned tenant.
    pub tenant: ProvisionedTenant,
    /// Its administrative principal and one-time credential.
    pub admin: ProvisionedTenantAdmin,
}

/// Request to restore administrative access to a tenant.
#[derive(Debug, Clone, Serialize, Deserialize, schemars::JsonSchema)]
#[cfg_attr(feature = "server", derive(utoipa::ToSchema))]
#[serde(deny_unknown_fields)]
pub struct RecoverTenantAdminRequest {
    /// Tenant whose administration is being restored.
    pub tenant_id: DataTenantId,
}

/// The live tenant directory.
///
/// Every lifecycle state is listed, soft-deleted rows excluded: an operator's
/// first question about a tenant is usually why it is not active, so filtering
/// to `active` would hide exactly the rows worth looking at.
#[derive(Debug, Clone, Serialize, Deserialize, schemars::JsonSchema)]
#[cfg_attr(feature = "server", derive(utoipa::ToSchema))]
pub struct TenantListResponse {
    /// Tenants newest first.
    pub tenants: Vec<ProvisionedTenant>,
}

/// Request to move a tenant between `active` and `suspended`.
///
/// Suspension is reversible and destroys nothing: the tenant's rows, grants,
/// and credentials survive, so resuming restores exactly what was there. The
/// states a tenant reaches on its own — `provisioning`, `failed` — are not
/// settable here, because an operator declaring them would contradict what
/// provisioning observed.
#[derive(Debug, Clone, Serialize, Deserialize, schemars::JsonSchema)]
#[cfg_attr(feature = "server", derive(utoipa::ToSchema))]
#[serde(deny_unknown_fields)]
pub struct SetTenantStatusRequest {
    /// Either `active` or `suspended`.
    pub status: String,
}