Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions doc/gatekeeper-api.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,24 @@
}
}
},
"/version": {
"/api/v1/version": {
"get": {
"summary": "Retrieve the API version",
"responses": {
"200": {
"description": "The API version string.",
"description": "The API version and commit hash.",
"content": {
"application/json": {
"schema": {
"type": "string"
"type": "object",
"properties": {
"version": {
"type": "string"
},
"commit": {
"type": "string"
}
}
}
}
}
Expand Down
251 changes: 251 additions & 0 deletions doc/keymaster-api.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,31 @@
}
}
},
"/api/v1/version": {
"get": {
"summary": "Retrieve the API version",
"responses": {
"200": {
"description": "The API version and commit hash.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"version": {
"type": "string"
},
"commit": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/registries": {
"get": {
"summary": "List the available registries.",
Expand Down Expand Up @@ -2073,6 +2098,232 @@
}
}
},
"/lightning": {
"post": {
"summary": "Create a Lightning wallet for the current identity.",
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Optional identity name or DID."
}
}
}
}
}
},
"responses": {
"200": {
"description": "Lightning wallet configuration."
},
"400": {
"description": "Error creating Lightning wallet."
}
}
},
"delete": {
"summary": "Remove Lightning wallet from the current identity.",
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Optional identity name or DID."
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success."
},
"400": {
"description": "Error removing Lightning wallet."
}
}
}
},
"/lightning/balance": {
"post": {
"summary": "Get Lightning wallet balance for the current identity.",
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Optional identity name or DID."
}
}
}
}
}
},
"responses": {
"200": {
"description": "Balance in sats."
},
"400": {
"description": "Error getting balance."
}
}
}
},
"/lightning/invoice": {
"post": {
"summary": "Create a Lightning invoice to receive sats.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"amount",
"memo"
],
"properties": {
"amount": {
"type": "number",
"description": "Amount in sats."
},
"memo": {
"type": "string",
"description": "Invoice description."
},
"id": {
"type": "string",
"description": "Optional identity name or DID."
}
}
}
}
}
},
"responses": {
"200": {
"description": "Lightning invoice."
},
"400": {
"description": "Error creating invoice."
}
}
}
},
"/lightning/pay": {
"post": {
"summary": "Pay a Lightning invoice.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"bolt11"
],
"properties": {
"bolt11": {
"type": "string",
"description": "BOLT11 invoice string."
},
"id": {
"type": "string",
"description": "Optional identity name or DID."
}
}
}
}
}
},
"responses": {
"200": {
"description": "Payment result."
},
"400": {
"description": "Error paying invoice."
}
}
}
},
"/lightning/payment": {
"post": {
"summary": "Check status of a Lightning payment.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"paymentHash"
],
"properties": {
"paymentHash": {
"type": "string",
"description": "Payment hash to check."
},
"id": {
"type": "string",
"description": "Optional identity name or DID."
}
}
}
}
}
},
"responses": {
"200": {
"description": "Payment status."
},
"400": {
"description": "Error checking payment."
}
}
}
},
"/lightning/decode": {
"post": {
"summary": "Decode a Lightning BOLT11 invoice.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bolt11": {
"type": "string"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Decoded invoice details."
},
"400": {
"description": "Error decoding invoice."
}
}
}
},
"/challenge": {
"get": {
"summary": "Create a default challenge DID with no parameters.",
Expand Down
Loading
Loading