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
179
180
181
182
183
184
185
186
187
188
189
190
use axum::response::{IntoResponse, Response};
use axum::routing::get;
use axum::{Json, Router};
use serde_json::json;
use crate::state::AppState;
pub fn routes() -> Router<AppState> {
Router::new().route("/v1/openapi.json", get(openapi_spec))
}
async fn openapi_spec() -> Response {
let spec = json!({
"openapi": "3.0.3",
"info": {
"title": "signal-cli REST API",
"description": "REST API bridge for signal-cli",
"version": env!("CARGO_PKG_VERSION")
},
"paths": {
"/v2/send": {
"post": {
"tags": ["Messages"],
"summary": "Send a message",
"operationId": "send",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/SendPayload" }
}
}
},
"responses": {
"201": { "description": "Message sent" },
"400": { "description": "Invalid request" }
}
}
},
"/v1/receive/{number}": {
"get": {
"tags": ["Messages"],
"summary": "Receive messages",
"operationId": "receive",
"parameters": [{
"name": "number",
"in": "path",
"required": true,
"schema": { "type": "string" }
}],
"responses": {
"200": { "description": "Array of messages" }
}
}
},
"/v1/health": {
"get": {
"tags": ["System"],
"summary": "Health check",
"operationId": "health",
"responses": {
"204": { "description": "Healthy" }
}
}
},
"/v1/about": {
"get": {
"tags": ["System"],
"summary": "API version info",
"operationId": "about",
"responses": {
"200": { "description": "Version information" }
}
}
},
"/v1/groups/{number}": {
"get": {
"tags": ["Groups"],
"summary": "List groups for an account",
"operationId": "listGroups",
"parameters": [{
"name": "number",
"in": "path",
"required": true,
"schema": { "type": "string" }
}],
"responses": {
"200": { "description": "Array of groups" }
}
}
},
"/v1/webhooks": {
"get": {
"tags": ["Webhooks"],
"summary": "List registered webhooks",
"operationId": "listWebhooks",
"responses": {
"200": { "description": "Array of webhook configs" }
}
},
"post": {
"tags": ["Webhooks"],
"summary": "Register a webhook",
"operationId": "createWebhook",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/WebhookConfig" }
}
}
},
"responses": {
"201": { "description": "Webhook registered" }
}
}
},
"/v1/events/{number}": {
"get": {
"tags": ["Events"],
"summary": "Server-Sent Events stream",
"operationId": "sseEvents",
"parameters": [{
"name": "number",
"in": "path",
"required": true,
"schema": { "type": "string" }
}],
"responses": {
"200": { "description": "SSE stream of messages" }
}
}
},
"/metrics": {
"get": {
"tags": ["System"],
"summary": "Prometheus metrics",
"operationId": "metrics",
"responses": {
"200": {
"description": "Prometheus-formatted metrics",
"content": {
"text/plain": {
"schema": { "type": "string" }
}
}
}
}
}
}
},
"components": {
"schemas": {
"SendPayload": {
"type": "object",
"required": ["message", "number", "recipients"],
"properties": {
"message": { "type": "string", "description": "Message text" },
"number": { "type": "string", "description": "Sender account number" },
"recipients": {
"type": "array",
"items": { "type": "string" },
"description": "Recipient numbers"
},
"base64_attachments": {
"type": "array",
"items": { "type": "string" },
"description": "Base64-encoded attachments"
}
}
},
"WebhookConfig": {
"type": "object",
"required": ["url"],
"properties": {
"id": { "type": "string", "description": "Webhook ID (server-generated)" },
"url": { "type": "string", "description": "Callback URL" },
"events": {
"type": "array",
"items": { "type": "string" },
"description": "Event types to subscribe to (empty = all)"
}
}
}
}
}
});
Json(spec).into_response()
}