atlas-confluence 0.2.0

Simple library to interact with the Confluence REST API
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178

use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct Space {
    pub id: u64,
    pub key: String,
    pub name: String,
    #[serde(rename = "_expandable")]
    pub expandable: SpaceExpandable,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct SpaceExpandable {
    pub homepage: Option<String>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct PageChildren {
    pub page: PaginatedResponse<ChildPage>,
    #[serde(rename = "_links")]
    pub links: Links,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct Page {
    pub id: String,
    pub title: String,
    pub status: String,
    pub space: Space,
    pub version: Version,
    pub body: Option<Body>,
    #[serde(rename = "_links")]
    pub links: Links,
    pub children: Option<PageChildren>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct ChildPage {
    pub id: String,
    pub title: String,
    pub status: String,
    #[serde(rename = "_links")]
    pub links: Links,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct Version {
    pub number: u64,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct Body {
    pub view: Option<BodyView>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct BodyView {
    pub value: String,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct SpacesResult {
    pub results: Vec<Space>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct Links {
    pub next: Option<String>,
    pub prev: Option<String>,
    pub base: Option<String>,
    pub webui: Option<String>,
    #[serde(rename = "self")]
    pub _self: String,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct PaginatedResponse<T> {
    pub size: u64,
    pub limit: u64,
    pub start: u64,
    #[serde(rename = "_links")]
    pub links: Links,
    pub results: Vec<T>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct SpaceContentResult {
    pub page: PaginatedResponse<Page>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct PostPage {
    pub id: Option<String>,
    #[serde(rename = "type")]
    pub t: String,
    pub title: String,
    pub ancestors: Option<Vec<PostAncestor>>,
    pub space: PostSpace,
    pub body: Option<PostBody>,
    pub version: Option<PostVersion>,
}
impl PostPage {
    pub fn new_new_page(
        title: String,
        ancestor: Option<u64>,
        space_key: String,
        body: Option<String>,
    ) -> Self {
        PostPage {
            id: None,
            t: "page".to_string(),
            title,
            ancestors: ancestor.map(|ancestor_id| {
                vec![PostAncestor {
                    id: format!("{ancestor_id}"),
                }]
            }),
            space: PostSpace { key: space_key },
            body: body.map(PostBody::new),
            version: None,
        }
    }
    pub fn new_update_page(
        id: u64,
        title: String,
        space_key: String,
        body: Option<String>,
        new_version: u64,
    ) -> Self {
        PostPage {
            id: Some(format!("{id}")),
            t: "page".to_string(),
            title,
            ancestors: None,
            space: PostSpace { key: space_key },
            body: body.map(PostBody::new),
            version: Some(PostVersion {
                number: new_version,
            }),
        }
    }
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct PostAncestor {
    pub id: String,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct PostSpace {
    pub key: String,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct PostBody {
    pub storage: PostStorage,
}
impl PostBody {
    pub fn new(value: String) -> Self {
        PostBody {
            storage: PostStorage {
                value,
                representation: "storage".to_string(),
            },
        }
    }
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct PostStorage {
    pub value: String,
    pub representation: String,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct PostVersion {
    pub number: u64,
}