You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: SERVICES.md
+28
Original file line number
Diff line number
Diff line change
@@ -13,6 +13,34 @@ target_port=8080 # the target port for your service
13
13
14
14
**PR's that do not include documentation of the service will not be merged**
15
15
16
+
- your service will receive any payload/query params from the initial client request as well as a JWT containing a basic user object with the following schema:
17
+
```json
18
+
{
19
+
"user":{
20
+
"username":"github_username",
21
+
"metadata": {
22
+
//General User Data TBD
23
+
"services": {
24
+
"your-service-name": {
25
+
//User metadata for your service - 500B max
26
+
}
27
+
}
28
+
}
29
+
}
30
+
}
31
+
```
32
+
- To update user metadata, make a POST request to `https://tulsawebdevs.org/api/userdata` with a JSON payload in the following schema:
33
+
```json
34
+
{
35
+
"username":"github_username",
36
+
"metadata": {
37
+
// User metadata for your service - 500B max
38
+
}
39
+
}
40
+
```
41
+
- The API will validate your request, attempt to write the user data if valid, and return a success or failure status.
42
+
*TBD: Auth/Validation/Rate Limit rules for this - will likely have a token endpoint and require a bearer token or similar for requests*
43
+
16
44
## Registered Services
17
45
*Use the following basic format `[repo link](https://myservicelocation)` - Service Name / short description
0 commit comments