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
//! `GET /api/parameters` and related runtime parameter endpoints.
use crate::api::encode_segment;
use crate::{Client, Result};
/// Request body for `PUT /api/parameters/{component}/{vhost}/{name}`.
/// The parameter value is wrapped in a `{"value": ...}` envelope.
#[derive(serde::Serialize)]
struct ParameterSet {
value: serde_json::Value,
}
impl Client {
/// `GET /api/parameters` — lists all runtime parameters, or those
/// of a single component via `GET /api/parameters/{component}` when
/// `component` is `Some`. Common component values include
/// `"federation-upstream"` and `"shovel"`.
pub async fn list_parameters(&self, component: Option<&str>) -> Result<Vec<serde_json::Value>> {
match component {
Some(c) => {
self.get(&format!("parameters/{}", encode_segment(c)), None)
.await
}
None => self.get("parameters", None).await,
}
}
/// `GET /api/parameters/{component}/{vhost}` — lists all runtime
/// parameters of a component within a single vhost. The component
/// and vhost are percent-encoded.
pub async fn list_parameters_in_vhost(
&self,
component: &str,
vhost: &str,
) -> Result<Vec<serde_json::Value>> {
self.get(
&format!(
"parameters/{}/{}",
encode_segment(component),
encode_segment(vhost)
),
None,
)
.await
}
/// `GET /api/parameters/{component}/{vhost}/{name}` — returns a
/// single runtime parameter. The component, vhost, and name are
/// percent-encoded.
pub async fn get_parameter(
&self,
component: &str,
vhost: &str,
name: &str,
) -> Result<serde_json::Value> {
self.get_ctx(
&format!(
"parameters/{}/{}/{}",
encode_segment(component),
encode_segment(vhost),
encode_segment(name)
),
None,
&format!("parameter '{name}' of component '{component}' in vhost '{vhost}'"),
)
.await
}
/// `PUT /api/parameters/{component}/{vhost}/{name}` — creates or
/// updates a runtime parameter; the value is sent as
/// `{"value": ...}`. Common component values include
/// `"federation-upstream"` and `"shovel"`. The component, vhost,
/// and name are percent-encoded.
pub async fn set_parameter(
&self,
component: &str,
vhost: &str,
name: &str,
value: serde_json::Value,
) -> Result<()> {
self.put(
&format!(
"parameters/{}/{}/{}",
encode_segment(component),
encode_segment(vhost),
encode_segment(name)
),
&ParameterSet { value },
)
.await
}
/// `DELETE /api/parameters/{component}/{vhost}/{name}` — deletes a
/// runtime parameter. The component, vhost, and name are
/// percent-encoded.
pub async fn delete_parameter(&self, component: &str, vhost: &str, name: &str) -> Result<()> {
self.delete_ctx(
&format!(
"parameters/{}/{}/{}",
encode_segment(component),
encode_segment(vhost),
encode_segment(name)
),
&format!("parameter '{name}' of component '{component}' in vhost '{vhost}'"),
)
.await
}
}