github-such-software/smirk-backend-core
1
0
Fork 0
mirror of https://github.com/Such-Software/smirk-backend-core.git synced 2026-10-17 07:21:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

feat(openapi): document bearer auth on the 28 token-gated routes

Browse Source 
The spec carried no security scheme, so generated clients/docs could not tell
which endpoints require a session token — e.g. /wallet/utxo/balance read as
public while its handler enforces auth via extract_user_id_from_token. Add a
`bearer_auth` HTTP/JWT scheme through a Modify addon and annotate every route
that resolves a session; auth-bootstrap, public username/key lookups, and
system routes stay open. Regenerated openapi.json (drift clean).
This commit is contained in:
jwinterm
2026-06-28 21:42:32 -04:00
parent 29efbf4494
commit 56c8dd463a
8 changed files with 236 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
openapi.json
+178 -29
View File
@@ -8,7 +8,8 @@
"email": "jw@such.software"
},
"license": {
"name": ""
"name": "MIT",
"identifier": "MIT"
},
"version": "0.3.0"
},
@@ -162,7 +163,12 @@
"401": {
"description": "Missing or invalid token"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/auth/nostr": {
@@ -225,7 +231,12 @@
"409": {
"description": "npub already linked to another account"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/auth/pow-challenge": {
@@ -426,7 +437,12 @@
"401": {
"description": "Missing or invalid token"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/prices": {
@@ -507,7 +523,12 @@
"401": {
"description": "Missing or invalid token"
}
}
},
"security": [
{
"bearer_auth": []
}
]
},
"post": {
"tags": [
@@ -543,7 +564,12 @@
"409": {
"description": "Username is taken or reserved"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/users/{user_id}/keys": {
@@ -666,7 +692,12 @@
"503": {
"description": "Upstream node unavailable"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/grin/height": {
@@ -696,7 +727,12 @@
"503": {
"description": "Upstream node unavailable"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/grin/relay/cancel": {
@@ -736,7 +772,12 @@
"409": {
"description": "Relay is already finalized"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/grin/relay/create": {
@@ -776,7 +817,12 @@
"404": {
"description": "Relay feature disabled"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/grin/relay/finalize": {
@@ -819,7 +865,12 @@
"409": {
"description": "Relay is not awaiting finalization"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/grin/relay/get": {
@@ -856,7 +907,12 @@
"404": {
"description": "Relay not found, not yours, or feature disabled"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/grin/relay/pending": {
@@ -883,7 +939,12 @@
"404": {
"description": "Relay feature disabled"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/grin/relay/respond": {
@@ -926,7 +987,12 @@
"409": {
"description": "Relay is not awaiting a recipient response"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/grin/scan": {
@@ -966,7 +1032,12 @@
"503": {
"description": "Upstream node unavailable"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/lws/balance": {
@@ -1006,7 +1077,12 @@
"503": {
"description": "Upstream node unavailable"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/lws/confirmations": {
@@ -1046,7 +1122,12 @@
"503": {
"description": "Upstream node unavailable"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/lws/height": {
@@ -1086,7 +1167,12 @@
"503": {
"description": "Upstream node unavailable"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/lws/history": {
@@ -1126,7 +1212,12 @@
"503": {
"description": "Upstream node unavailable"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/lws/random_outs": {
@@ -1166,7 +1257,12 @@
"503": {
"description": "Upstream node unavailable"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/lws/register": {
@@ -1206,7 +1302,12 @@
"503": {
"description": "Upstream node unavailable"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/lws/submit_tx": {
@@ -1246,7 +1347,12 @@
"503": {
"description": "Upstream node unavailable"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/lws/unspent_outs": {
@@ -1286,7 +1392,12 @@
"503": {
"description": "Upstream node unavailable"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/utxo/balance": {
@@ -1326,7 +1437,12 @@
"503": {
"description": "Upstream node unavailable"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/utxo/broadcast": {
@@ -1366,7 +1482,12 @@
"503": {
"description": "Upstream node unavailable"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/utxo/fee": {
@@ -1406,7 +1527,12 @@
"503": {
"description": "Upstream node unavailable"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/utxo/history": {
@@ -1446,7 +1572,12 @@
"503": {
"description": "Upstream node unavailable"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/utxo/tip": {
@@ -1486,7 +1617,12 @@
"503": {
"description": "Upstream node unavailable"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
},
"/wallet/utxo/utxos": {
@@ -1526,7 +1662,12 @@
"503": {
"description": "Upstream node unavailable"
}
}
},
"security": [
{
"bearer_auth": []
}
]
}
}
},
@@ -3244,6 +3385,14 @@
}
}
}
},
"securitySchemes": {
"bearer_auth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "Session access token issued by the /auth/* endpoints."
}
}
},
"tags": [