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
|
use ruma_common::{
api::ruma_api,
events::{tag::TagEvent, AnyTimelineEvent},
serde::Raw,
};
ruma_api! {
metadata: {
description: "Does something.",
method: POST, // An `http::Method` constant. No imports required.
name: "some_endpoint",
unstable_path: "/_matrix/some/msc1234/endpoint/:baz",
r0_path: "/_matrix/some/r0/endpoint/:baz",
stable_path: "/_matrix/some/v1/endpoint/:baz",
rate_limited: false,
authentication: None,
added: 1.0,
deprecated: 1.1,
removed: 1.2,
}
request: {
// With no attribute on the field, it will be put into the body of the request.
pub foo: String,
// This value will be put into the "Content-Type" HTTP header.
#[ruma_api(header = CONTENT_TYPE)]
pub content_type: String,
// This value will be put into the query string of the request's URL.
#[ruma_api(query)]
pub bar: String,
// This value will be inserted into the request's URL in place of the
// ":baz" path component.
#[ruma_api(path)]
pub baz: String,
}
response: {
// This value will be extracted from the "Content-Type" HTTP header.
#[ruma_api(header = CONTENT_TYPE)]
pub content_type: String,
// With no attribute on the field, it will be extracted from the body of the response.
pub value: String,
// You can use serde attributes on any kind of field
#[serde(skip_serializing_if = "Option::is_none")]
pub optional_flag: Option<bool>,
// Use `Raw` instead of the actual event to allow additional fields to be sent...
pub event: Raw<TagEvent>,
// ... and to allow unknown events when the endpoint deals with event collections.
pub list_of_events: Vec<Raw<AnyTimelineEvent>>,
}
}
fn main() {
use ruma_common::api::MatrixVersion;
assert_eq!(METADATA.unstable_path, Some("/_matrix/some/msc1234/endpoint/:baz"));
assert_eq!(METADATA.r0_path, Some("/_matrix/some/r0/endpoint/:baz"));
assert_eq!(METADATA.stable_path, Some("/_matrix/some/v1/endpoint/:baz"));
assert_eq!(METADATA.added, Some(MatrixVersion::V1_0));
assert_eq!(METADATA.deprecated, Some(MatrixVersion::V1_1));
assert_eq!(METADATA.removed, Some(MatrixVersion::V1_2));
}
|
