Skip to content

Commit c9c6017

Browse files
ogazboizogazboiz
authored
Merge pull request #218 from Itodo-S/feature/complete-api-collections
feat: complete API collections with all documented endpoints
2 parents f1ae166 + 6a367a9 commit c9c6017

6 files changed

Lines changed: 501 additions & 146 deletions

‎docs/api/flowfi.hoppscotch_collection.json‎

Lines changed: 165 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,34 @@
3636
"auth": { "authType": "inherit", "authActive": true },
3737
"body": { "contentType": null, "body": null },
3838
"requestVariables": []
39+
},
40+
{
41+
"v": "1",
42+
"id": "f6a7b8c9-d0e1-2345-fabc-345678901236",
43+
"name": "Swagger UI",
44+
"method": "GET",
45+
"endpoint": "<<baseUrl>>/api-docs",
46+
"params": [],
47+
"headers": [],
48+
"preRequestScript": "",
49+
"testScript": "",
50+
"auth": { "authType": "inherit", "authActive": true },
51+
"body": { "contentType": null, "body": null },
52+
"requestVariables": []
53+
},
54+
{
55+
"v": "1",
56+
"id": "f6a7b8c9-d0e1-2345-fabc-345678901237",
57+
"name": "OpenAPI JSON spec",
58+
"method": "GET",
59+
"endpoint": "<<baseUrl>>/api-docs.json",
60+
"params": [],
61+
"headers": [],
62+
"preRequestScript": "",
63+
"testScript": "",
64+
"auth": { "authType": "inherit", "authActive": true },
65+
"body": { "contentType": null, "body": null },
66+
"requestVariables": []
3967
}
4068
]
4169
},
@@ -50,7 +78,7 @@
5078
"id": "b8c9d0e1-f2a3-4567-bcde-567890123457",
5179
"name": "Create stream",
5280
"method": "POST",
53-
"endpoint": "<<baseUrl>>/streams",
81+
"endpoint": "<<baseUrl>>/v1/streams",
5482
"params": [],
5583
"headers": [
5684
{ "key": "Content-Type", "value": "application/json", "active": true }
@@ -63,23 +91,155 @@
6391
"body": "{\n \"sender\": \"<<senderPublicKey>>\",\n \"recipient\": \"<<recipientPublicKey>>\",\n \"amount\": 10000,\n \"token\": \"<<tokenAddress>>\",\n \"startTime\": 1708531200,\n \"endTime\": 1711209600\n}"
6492
},
6593
"requestVariables": []
94+
},
95+
{
96+
"v": "1",
97+
"id": "b8c9d0e1-f2a3-4567-bcde-567890123458",
98+
"name": "List streams",
99+
"method": "GET",
100+
"endpoint": "<<baseUrl>>/v1/streams",
101+
"params": [
102+
{ "key": "sender", "value": "<<senderPublicKey>>", "active": true },
103+
{ "key": "recipient", "value": "<<recipientPublicKey>>", "active": false }
104+
],
105+
"headers": [],
106+
"preRequestScript": "",
107+
"testScript": "",
108+
"auth": { "authType": "inherit", "authActive": true },
109+
"body": { "contentType": null, "body": null },
110+
"requestVariables": []
111+
},
112+
{
113+
"v": "1",
114+
"id": "b8c9d0e1-f2a3-4567-bcde-567890123459",
115+
"name": "Get stream by ID",
116+
"method": "GET",
117+
"endpoint": "<<baseUrl>>/v1/streams/<<streamId>>",
118+
"params": [],
119+
"headers": [],
120+
"preRequestScript": "",
121+
"testScript": "",
122+
"auth": { "authType": "inherit", "authActive": true },
123+
"body": { "contentType": null, "body": null },
124+
"requestVariables": []
125+
},
126+
{
127+
"v": "1",
128+
"id": "b8c9d0e1-f2a3-4567-bcde-567890123460",
129+
"name": "Get stream events",
130+
"method": "GET",
131+
"endpoint": "<<baseUrl>>/v1/streams/<<streamId>>/events",
132+
"params": [],
133+
"headers": [],
134+
"preRequestScript": "",
135+
"testScript": "",
136+
"auth": { "authType": "inherit", "authActive": true },
137+
"body": { "contentType": null, "body": null },
138+
"requestVariables": []
139+
},
140+
{
141+
"v": "1",
142+
"id": "b8c9d0e1-f2a3-4567-bcde-567890123461",
143+
"name": "Get claimable amount",
144+
"method": "GET",
145+
"endpoint": "<<baseUrl>>/v1/streams/<<streamId>>/claimable",
146+
"params": [
147+
{ "key": "at", "value": "", "active": false }
148+
],
149+
"headers": [],
150+
"preRequestScript": "",
151+
"testScript": "",
152+
"auth": { "authType": "inherit", "authActive": true },
153+
"body": { "contentType": null, "body": null },
154+
"requestVariables": []
155+
}
156+
]
157+
},
158+
{
159+
"v": 1,
160+
"id": "a7b8c9d0-e1f2-3456-abcd-456789012347",
161+
"name": "Users",
162+
"folders": [],
163+
"requests": [
164+
{
165+
"v": "1",
166+
"id": "c9d0e1f2-a3b4-5678-cdef-678901234570",
167+
"name": "Register wallet",
168+
"method": "POST",
169+
"endpoint": "<<baseUrl>>/v1/users",
170+
"params": [],
171+
"headers": [
172+
{ "key": "Content-Type", "value": "application/json", "active": true }
173+
],
174+
"preRequestScript": "",
175+
"testScript": "",
176+
"auth": { "authType": "inherit", "authActive": true },
177+
"body": {
178+
"contentType": "application/json",
179+
"body": "{\n \"publicKey\": \"<<senderPublicKey>>\"\n}"
180+
},
181+
"requestVariables": []
182+
},
183+
{
184+
"v": "1",
185+
"id": "c9d0e1f2-a3b4-5678-cdef-678901234571",
186+
"name": "Get user by public key",
187+
"method": "GET",
188+
"endpoint": "<<baseUrl>>/v1/users/<<senderPublicKey>>",
189+
"params": [],
190+
"headers": [],
191+
"preRequestScript": "",
192+
"testScript": "",
193+
"auth": { "authType": "inherit", "authActive": true },
194+
"body": { "contentType": null, "body": null },
195+
"requestVariables": []
196+
},
197+
{
198+
"v": "1",
199+
"id": "c9d0e1f2-a3b4-5678-cdef-678901234572",
200+
"name": "Get current user (authenticated)",
201+
"method": "GET",
202+
"endpoint": "<<baseUrl>>/v1/users/me",
203+
"params": [],
204+
"headers": [
205+
{ "key": "Authorization", "value": "Bearer <<authToken>>", "active": true }
206+
],
207+
"preRequestScript": "",
208+
"testScript": "",
209+
"auth": { "authType": "inherit", "authActive": true },
210+
"body": { "contentType": null, "body": null },
211+
"requestVariables": []
212+
},
213+
{
214+
"v": "1",
215+
"id": "c9d0e1f2-a3b4-5678-cdef-678901234573",
216+
"name": "Get user activity events",
217+
"method": "GET",
218+
"endpoint": "<<baseUrl>>/v1/users/<<senderPublicKey>>/events",
219+
"params": [],
220+
"headers": [],
221+
"preRequestScript": "",
222+
"testScript": "",
223+
"auth": { "authType": "inherit", "authActive": true },
224+
"body": { "contentType": null, "body": null },
225+
"requestVariables": []
66226
}
67227
]
68228
},
69229
{
70230
"v": 1,
71231
"id": "c9d0e1f2-a3b4-5678-cdef-678901234568",
72-
"name": "Events",
232+
"name": "Events (SSE)",
73233
"folders": [],
74234
"requests": [
75235
{
76236
"v": "1",
77237
"id": "d0e1f2a3-b4c5-6789-defa-789012345679",
78238
"name": "Subscribe to stream events (SSE)",
79239
"method": "GET",
80-
"endpoint": "<<baseUrl>>/events/subscribe",
240+
"endpoint": "<<baseUrl>>/v1/events/subscribe",
81241
"params": [
82-
{ "key": "streams", "value": "123", "active": true },
242+
{ "key": "streams", "value": "<<streamId>>", "active": true },
83243
{ "key": "users", "value": "<<senderPublicKey>>", "active": true },
84244
{ "key": "all", "value": "false", "active": true }
85245
],
@@ -98,7 +258,7 @@
98258
"id": "e1f2a3b4-c5d6-7890-efab-890123456780",
99259
"name": "Get SSE connection stats",
100260
"method": "GET",
101-
"endpoint": "<<baseUrl>>/events/stats",
261+
"endpoint": "<<baseUrl>>/v1/events/stats",
102262
"params": [],
103263
"headers": [],
104264
"preRequestScript": "",

0 commit comments

Comments
 (0)