ockam_api 0.93.0

Ockam's request-response API
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

use super::common::{default_project_information, Attributes, Project};
use crate::control_api::protocol::common::HostnamePort;
use serde::{Deserialize, Serialize};
use utoipa::ToSchema;

fn default_usage_count() -> u64 {
    1
}

fn default_expires_in() -> u64 {
    600
}

#[derive(Debug, Serialize, Deserialize, ToSchema)]
#[serde(rename_all = "kebab-case")]
pub struct CreateTicketRequest {
    pub attributes: Attributes,
    /// Identity to use when contacting the Authority node;
    /// When omitted, the default identity will be used
    #[schema(examples("Id3b788c6a89de8b1f2fd13743eb3123178cf6ec7c9253be8ddcf7e154abe016a"))]
    pub identity: Option<String>,
    /// Project information to use when creating the ticket;
    #[serde(default = "default_project_information")]
    #[schema(default = default_project_information)]
    pub project: Project,
    /// Number of times the ticket can be used to enroll;
    #[serde(default = "default_usage_count")]
    #[schema(default = default_usage_count)]
    pub usage_count: u64,
    /// Duration for which the enrollment ticket is valid;
    /// The value is expressed in seconds.
    #[serde(default = "default_expires_in")]
    #[schema(default = default_expires_in)]
    pub expires_in: u64,
}

#[derive(Debug, Serialize, Deserialize, ToSchema)]
#[serde(rename_all = "kebab-case")]
pub struct Ticket {
    /// Encoded ticket;
    /// The ticket is encoded in a format that is understood by the Ockam Command and it may
    /// vary over time.
    pub encoded: String,
}

#[derive(Debug, Serialize, Deserialize, ToSchema)]
pub struct EnrollProjectRequest {
    /// Identity to enroll;
    /// When omitted, the default identity will be used
    #[schema(examples("Id3b788c6a89de8b1f2fd13743eb3123178cf6ec7c9253be8ddcf7e154abe016a"))]
    pub identity: Option<String>,

    /// Ticket to use for enrollment;
    /// The encoded ticket
    pub ticket: String,
}

#[derive(Debug, Serialize, Deserialize, ToSchema)]
pub struct AuthorityInformation {
    /// Route to the authority node
    pub route: String,
    /// Identity of the authority node
    pub identity: String,
    /// Hostname and port of the authority node
    pub address: HostnamePort,
}