{ "openapi": "3.1.1", "info": { "title": "Immanuel.KeyValue.Web | v1", "version": "1.0.0" }, "servers": [ { "url": "https://kv-store.immanuel.co/" } ], "paths": { "/health": { "get": { "tags": [ "Immanuel.KeyValue.Web" ], "responses": { "200": { "description": "OK" } } } }, "/api/v2/me": { "get": { "tags": [ "Account" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/me/appkeys": { "post": { "tags": [ "Account" ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppKeyResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Account" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppKeyResponse" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/me/appkeys/{appkey}": { "delete": { "tags": [ "Account" ], "parameters": [ { "name": "appkey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content", "content": { "application/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/me/header": { "get": { "tags": [ "Account" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiHeaderResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Account" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetApiHeaderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetApiHeaderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetApiHeaderRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiHeaderResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Account" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/me/header/suggest": { "get": { "tags": [ "Account" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestedHeaderResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/auth/signup": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EmailRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EmailRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtpSentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/auth/signin": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EmailRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EmailRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtpSentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/auth/verify": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VerifyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/auth/signout": { "post": { "tags": [ "Auth" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { } } } } } }, "/api/v2/auth/state": { "get": { "tags": [ "Auth" ], "responses": { "200": { "description": "OK", "content": { "application/json": { } } } } } }, "/api/KeyVal/GetAppKey": { "get": { "tags": [ "KeyVal" ], "responses": { "200": { "description": "OK", "content": { "application/json": { } } } } } }, "/api/KeyVal/GetCount": { "get": { "tags": [ "KeyVal" ], "responses": { "200": { "description": "OK", "content": { "application/json": { } } } } } }, "/api/KeyVal/GetValue/{appkey}/{key}": { "get": { "tags": [ "KeyVal" ], "parameters": [ { "name": "appkey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { } } } } } }, "/api/KeyVal/UpdateValue/{appkey}/{key}": { "post": { "tags": [ "KeyVal" ], "parameters": [ { "name": "appkey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { } } } } } }, "/api/KeyVal/UpdateValue/{appkey}/{key}/{value}": { "post": { "tags": [ "KeyVal" ], "parameters": [ { "name": "appkey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { } } } } } }, "/api/KeyVal/ActOnValue/{appkey}/{key}/{value}": { "post": { "tags": [ "KeyVal" ], "parameters": [ { "name": "appkey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { } } } } } }, "/api/KeyVal/GetIp": { "get": { "tags": [ "KeyVal" ], "responses": { "200": { "description": "OK", "content": { "application/json": { } } } } } }, "/api/v2/appkeys": { "post": { "tags": [ "Store" ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppKeyCreatedResponse" } } } } } } }, "/api/v2/appkeys/{appkey}": { "get": { "tags": [ "Store" ], "parameters": [ { "name": "appkey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppKeyResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/appkeys/{appkey}/keys": { "get": { "tags": [ "Store" ], "parameters": [ { "name": "appkey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueResponse" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/appkeys/{appkey}/keys/{key}": { "get": { "tags": [ "Store" ], "parameters": [ { "name": "appkey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValueResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Store" ], "parameters": [ { "name": "appkey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetValueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetValueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetValueRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValueResponse" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValueResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Store" ], "parameters": [ { "name": "appkey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content", "content": { "application/json": { } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/appkeys/{appkey}/keys/{key}/increment": { "post": { "tags": [ "Store" ], "parameters": [ { "name": "appkey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AdjustRequest" } ] } }, "text/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AdjustRequest" } ] } }, "application/*+json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AdjustRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValueResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/stats": { "get": { "tags": [ "Store" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatsResponse" } } } } } } } }, "components": { "schemas": { "AccountResponse": { "required": [ "email", "folder", "createdAt", "lastLoginAt", "apiHeader", "appKeys" ], "type": "object", "properties": { "email": { "type": "string" }, "folder": { "type": "string" }, "createdAt": { "type": "string" }, "lastLoginAt": { "type": [ "null", "string" ] }, "apiHeader": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ApiHeaderResponse" } ] }, "appKeys": { "type": "array", "items": { "$ref": "#/components/schemas/AppKeyResponse" } } } }, "AdjustRequest": { "type": "object", "properties": { "by": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64", "default": 1 } } }, "ApiHeaderResponse": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "AppKeyCreatedResponse": { "required": [ "appKey", "message" ], "type": "object", "properties": { "appKey": { "type": "string" }, "message": { "type": "string" } } }, "AppKeyResponse": { "required": [ "appKey", "keyCount", "createdAt", "lastAccessAt" ], "type": "object", "properties": { "appKey": { "type": "string" }, "keyCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "createdAt": { "type": "string" }, "lastAccessAt": { "type": [ "null", "string" ] } } }, "EmailRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": [ "null", "string" ] } } }, "OtpSentResponse": { "required": [ "email", "delivery", "message", "code" ], "type": "object", "properties": { "email": { "type": "string" }, "delivery": { "type": "string" }, "message": { "type": "string" }, "code": { "type": [ "null", "string" ] } } }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] } } }, "SessionResponse": { "required": [ "token", "expiresAt", "account" ], "type": "object", "properties": { "token": { "type": "string" }, "expiresAt": { "type": "string" }, "account": { "$ref": "#/components/schemas/AccountResponse" } } }, "SetApiHeaderRequest": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "value": { "type": [ "null", "string" ] } } }, "SetValueRequest": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": [ "null", "string" ] } } }, "StatsResponse": { "required": [ "appKeys", "keys" ], "type": "object", "properties": { "appKeys": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "keys": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "SuggestedHeaderResponse": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "ValueResponse": { "required": [ "key", "value", "createdAt", "updatedAt" ], "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": [ "null", "string" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "VerifyRequest": { "required": [ "email", "code" ], "type": "object", "properties": { "email": { "type": [ "null", "string" ] }, "code": { "type": [ "null", "string" ] } } } } }, "tags": [ { "name": "Immanuel.KeyValue.Web" }, { "name": "Account" }, { "name": "Auth" }, { "name": "KeyVal" }, { "name": "Store" } ] }