{ "openapi": "3.0.3", "info": { "title": "Fusio", "description": "Self-Hosted API Management for Builders.", "version": "1" }, "servers": [ { "url": "https://demo.fusio-project.org" } ], "paths": { "/backend/account/change_password": { "put": { "tags": [ "account" ], "description": "Changes the password of the authenticated user", "operationId": "backend.account.changePassword", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_AccountChangePassword" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.account" ] } ] } }, "/backend/account": { "get": { "tags": [ "account" ], "description": "Returns user data of the authenticated user", "operationId": "backend.account.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_User" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.account" ] } ] }, "put": { "tags": [ "account" ], "description": "Updates user data of the authenticated user", "operationId": "backend.account.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_UserUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.account" ] } ] } }, "/backend/action": { "get": { "tags": [ "action" ], "description": "Returns a paginated list of actions", "operationId": "backend.action.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_ActionCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.action" ] } ] }, "post": { "tags": [ "action" ], "description": "Creates a new action", "operationId": "backend.action.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_ActionCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.action" ] } ] } }, "/backend/action/{action_id}": { "get": { "tags": [ "action" ], "description": "Returns a specific action", "operationId": "backend.action.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Action" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.action" ] } ] }, "put": { "tags": [ "action" ], "description": "Updates an existing action", "operationId": "backend.action.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_ActionUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.action" ] } ] }, "delete": { "tags": [ "action" ], "description": "Deletes an existing action", "operationId": "backend.action.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.action" ] } ] }, "parameters": [ { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/action/execute/{action_id}": { "post": { "tags": [ "action" ], "description": "Executes a specific action. This method should be used to test an action configuration", "operationId": "backend.action.execute", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_ActionExecuteRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_ActionExecuteResponse" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.action" ] } ] }, "parameters": [ { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/action/list": { "get": { "tags": [ "action" ], "description": "Returns all available action classes", "operationId": "backend.action.getClasses", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_ActionIndex" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.action" ] } ] } }, "/backend/action/{action_id}/commit": { "get": { "tags": [ "action" ], "description": "Returns a paginated list of action commits", "operationId": "backend.action.getCommits", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_ActionCommitCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.action" ] } ] }, "parameters": [ { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/action/form": { "get": { "tags": [ "action" ], "description": "Returns the action config form", "operationId": "backend.action.getForm", "parameters": [ { "name": "class", "in": "query", "description": "The target action class", "required": false, "schema": { "description": "The target action class", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_FormContainer" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.action" ] } ] } }, "/backend/agent": { "get": { "tags": [ "agent" ], "description": "Returns a paginated list of agents", "operationId": "backend.agent.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_AgentCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.agent" ] } ] }, "post": { "tags": [ "agent" ], "description": "Creates a new agent", "operationId": "backend.agent.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_AgentCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.agent" ] } ] } }, "/backend/agent/{agent_id}": { "get": { "tags": [ "agent" ], "description": "Returns a specific agent", "operationId": "backend.agent.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Agent" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.agent" ] } ] }, "put": { "tags": [ "agent" ], "description": "Updates an existing agent", "operationId": "backend.agent.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_AgentUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.agent" ] } ] }, "delete": { "tags": [ "agent" ], "description": "Deletes an existing agent", "operationId": "backend.agent.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.agent" ] } ] }, "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/agent/tools": { "get": { "tags": [ "agent" ], "description": "Returns available tools for an agent", "operationId": "backend.agent.getTools", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_AgentTools" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.agent" ] } ] } }, "/backend/agent/{agent_id}/message": { "get": { "tags": [ "agent" ], "description": "Returns a paginated list of agent messages", "operationId": "backend.agent.message.getAll", "parameters": [ { "name": "chat_id", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_AgentMessageCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.agent" ] } ] }, "post": { "tags": [ "agent" ], "description": "Submits a new agent message", "operationId": "backend.agent.message.submit", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agent_Input" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agent_Output" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.agent" ] } ] }, "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/app": { "get": { "tags": [ "app" ], "description": "Returns a paginated list of apps", "operationId": "backend.app.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_AppCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.app" ] } ] }, "post": { "tags": [ "app" ], "description": "Creates a new app", "operationId": "backend.app.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_AppCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.app" ] } ] } }, "/backend/app/{app_id}": { "get": { "tags": [ "app" ], "description": "Returns a specific app", "operationId": "backend.app.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_App" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.app" ] } ] }, "put": { "tags": [ "app" ], "description": "Updates an existing app", "operationId": "backend.app.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_AppUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.app" ] } ] }, "delete": { "tags": [ "app" ], "description": "Deletes an existing app", "operationId": "backend.app.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.app" ] } ] }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/app/{app_id}/token/{token_id}": { "delete": { "tags": [ "app" ], "description": "Deletes an existing token from an app", "operationId": "backend.app.deleteToken", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.app" ] } ] }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "token_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/audit/{audit_id}": { "get": { "tags": [ "audit" ], "description": "Returns a specific audit", "operationId": "backend.audit.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Audit" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.audit" ] } ] }, "parameters": [ { "name": "audit_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/audit": { "get": { "tags": [ "audit" ], "description": "Returns a paginated list of audits", "operationId": "backend.audit.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "event", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "message", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_AuditCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.audit" ] } ] } }, "/backend/backup/export": { "post": { "tags": [ "backup" ], "description": "Generates an backup of the current system", "operationId": "backend.backup.export", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_BackupExport" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.backup" ] } ] } }, "/backend/backup/import": { "post": { "tags": [ "backup" ], "description": "Imports an backup to the current system", "operationId": "backend.backup.import", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_BackupImport" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_BackupImportResult" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.backup" ] } ] } }, "/backend/bundle": { "get": { "tags": [ "bundle" ], "description": "Returns a paginated list of bundles", "operationId": "backend.bundle.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_BundleCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.bundle" ] } ] }, "post": { "tags": [ "bundle" ], "description": "Creates a new bundle", "operationId": "backend.bundle.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_BundleCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.bundle" ] } ] } }, "/backend/bundle/{bundle_id}": { "get": { "tags": [ "bundle" ], "description": "Returns a specific bundle", "operationId": "backend.bundle.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Bundle" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.bundle" ] } ] }, "put": { "tags": [ "bundle" ], "description": "Updates an existing bundle", "operationId": "backend.bundle.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_BundleUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.bundle" ] } ] }, "delete": { "tags": [ "bundle" ], "description": "Deletes an existing bundle", "operationId": "backend.bundle.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.bundle" ] } ] }, "parameters": [ { "name": "bundle_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/bundle/{bundle_id}/publish": { "post": { "tags": [ "bundle" ], "description": "Publish an existing bundle to the marketplace", "operationId": "backend.bundle.publish", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.bundle" ] } ] }, "parameters": [ { "name": "bundle_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/category": { "get": { "tags": [ "category" ], "description": "Returns a paginated list of categories", "operationId": "backend.category.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_CategoryCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.category" ] } ] }, "post": { "tags": [ "category" ], "description": "Creates a new category", "operationId": "backend.category.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_CategoryCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.category" ] } ] } }, "/backend/category/{category_id}": { "get": { "tags": [ "category" ], "description": "Returns a specific category", "operationId": "backend.category.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Category" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.category" ] } ] }, "put": { "tags": [ "category" ], "description": "Updates an existing category", "operationId": "backend.category.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_CategoryUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.category" ] } ] }, "delete": { "tags": [ "category" ], "description": "Deletes an existing category", "operationId": "backend.category.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.category" ] } ] }, "parameters": [ { "name": "category_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/config/{config_id}": { "get": { "tags": [ "config" ], "description": "Returns a specific config", "operationId": "backend.config.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Config" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.config" ] } ] }, "put": { "tags": [ "config" ], "description": "Updates an existing config value", "operationId": "backend.config.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_ConfigUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.config" ] } ] }, "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/config": { "get": { "tags": [ "config" ], "description": "Returns a paginated list of configuration values", "operationId": "backend.config.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_ConfigCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.config" ] } ] } }, "/backend/connection/{connection_id}/agent": { "post": { "tags": [ "connection" ], "description": "Sends a message to an agent", "operationId": "backend.connection.agent.send", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agent_Input" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agent_Output" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/connection": { "get": { "tags": [ "connection" ], "description": "Returns a paginated list of connections", "operationId": "backend.connection.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "class", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_ConnectionCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "post": { "tags": [ "connection" ], "description": "Creates a new connection", "operationId": "backend.connection.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_ConnectionCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] } }, "/backend/connection/{connection_id}/database/{table_name}/rows": { "get": { "tags": [ "connection" ], "description": "Returns paginated rows at a table on a database", "operationId": "backend.connection.database.getRows", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "filterBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filterOp", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filterValue", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "columns", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_DatabaseRowCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "post": { "tags": [ "connection" ], "description": "Creates a new row at a table on a database", "operationId": "backend.connection.database.createRow", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_DatabaseRow" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_name", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/connection/{connection_id}/database": { "get": { "tags": [ "connection" ], "description": "Returns all available tables on a database", "operationId": "backend.connection.database.getTables", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_DatabaseTableCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "post": { "tags": [ "connection" ], "description": "Creates a new table on a database", "operationId": "backend.connection.database.createTable", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_DatabaseTable" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/connection/{connection_id}/database/{table_name}/rows/{id}": { "get": { "tags": [ "connection" ], "description": "Returns a specific row at a table on a database", "operationId": "backend.connection.database.getRow", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_DatabaseRow" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "put": { "tags": [ "connection" ], "description": "Updates an existing row at a table on a database", "operationId": "backend.connection.database.updateRow", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_DatabaseRow" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "delete": { "tags": [ "connection" ], "description": "Deletes an existing row at a table on a database", "operationId": "backend.connection.database.deleteRow", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/connection/{connection_id}/database/{table_name}": { "get": { "tags": [ "connection" ], "description": "Returns the schema of a specific table on a database", "operationId": "backend.connection.database.getTable", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_DatabaseTable" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "put": { "tags": [ "connection" ], "description": "Updates an existing table on a database", "operationId": "backend.connection.database.updateTable", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_DatabaseTable" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "delete": { "tags": [ "connection" ], "description": "Deletes an existing table on a database", "operationId": "backend.connection.database.deleteTable", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_name", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/connection/{connection_id}": { "get": { "tags": [ "connection" ], "description": "Returns a specific connection", "operationId": "backend.connection.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Connection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "put": { "tags": [ "connection" ], "description": "Updates an existing connection", "operationId": "backend.connection.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_ConnectionUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "delete": { "tags": [ "connection" ], "description": "Deletes an existing connection", "operationId": "backend.connection.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/connection/{connection_id}/filesystem": { "get": { "tags": [ "connection" ], "description": "Returns all available files on the filesystem connection", "operationId": "backend.connection.filesystem.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_FileCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "post": { "tags": [ "connection" ], "description": "Uploads one or more files on the filesystem connection", "operationId": "backend.connection.filesystem.create", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "string" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/connection/{connection_id}/filesystem/{file_id}": { "get": { "tags": [ "connection" ], "description": "Returns the content of the provided file id on the filesystem connection", "operationId": "backend.connection.filesystem.get", "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "put": { "tags": [ "connection" ], "description": "Updates an existing file on the filesystem connection", "operationId": "backend.connection.filesystem.update", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "delete": { "tags": [ "connection" ], "description": "Deletes an existing file on the filesystem connection", "operationId": "backend.connection.filesystem.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/connection/list": { "get": { "tags": [ "connection" ], "description": "Returns all available connection classes", "operationId": "backend.connection.getClasses", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_ConnectionIndex" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] } }, "/backend/connection/form": { "get": { "tags": [ "connection" ], "description": "Returns the connection config form", "operationId": "backend.connection.getForm", "parameters": [ { "name": "class", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_FormContainer" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] } }, "/backend/connection/{connection_id}/redirect": { "get": { "tags": [ "connection" ], "description": "Returns a redirect url to start the OAuth2 authorization flow for the given connection", "operationId": "backend.connection.getRedirect", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_ConnectionRedirectResponse" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/connection/{connection_id}/http": { "post": { "tags": [ "connection" ], "description": "Sends an arbitrary HTTP request to the connection", "operationId": "backend.connection.http.execute", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_HttpRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_HttpResponse" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/connection/{connection_id}/sdk": { "get": { "tags": [ "connection" ], "description": "Returns the SDK specification", "operationId": "backend.connection.sdk.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Passthru" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.connection" ] } ] }, "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/cronjob": { "get": { "tags": [ "cronjob" ], "description": "Returns a paginated list of cronjobs", "operationId": "backend.cronjob.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "taxonomy", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_CronjobCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.cronjob" ] } ] }, "post": { "tags": [ "cronjob" ], "description": "Creates a new cronjob", "operationId": "backend.cronjob.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_CronjobCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.cronjob" ] } ] } }, "/backend/cronjob/{cronjob_id}": { "get": { "tags": [ "cronjob" ], "description": "Returns a specific cronjob", "operationId": "backend.cronjob.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Cronjob" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.cronjob" ] } ] }, "put": { "tags": [ "cronjob" ], "description": "Updates an existing cronjob", "operationId": "backend.cronjob.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_CronjobUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.cronjob" ] } ] }, "delete": { "tags": [ "cronjob" ], "description": "Deletes an existing cronjob", "operationId": "backend.cronjob.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.cronjob" ] } ] }, "parameters": [ { "name": "cronjob_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/dashboard": { "get": { "tags": [ "dashboard" ], "description": "Returns all available dashboard widgets", "operationId": "backend.dashboard.getAll", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Dashboard" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.dashboard" ] } ] } }, "/backend/event": { "get": { "tags": [ "event" ], "description": "Returns a paginated list of events", "operationId": "backend.event.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "taxonomy", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_EventCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.event" ] } ] }, "post": { "tags": [ "event" ], "description": "Creates a new event", "operationId": "backend.event.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_EventCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.event" ] } ] } }, "/backend/event/{event_id}": { "get": { "tags": [ "event" ], "description": "Returns a specific event", "operationId": "backend.event.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Event" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.event" ] } ] }, "put": { "tags": [ "event" ], "description": "Updates an existing event", "operationId": "backend.event.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_EventUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.event" ] } ] }, "delete": { "tags": [ "event" ], "description": "Deletes an existing event", "operationId": "backend.event.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.event" ] } ] }, "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/firewall": { "get": { "tags": [ "firewall" ], "description": "Returns a paginated list of firewall rules", "operationId": "backend.firewall.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_FirewallCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.firewall" ] } ] }, "post": { "tags": [ "firewall" ], "description": "Creates a new firewall rule", "operationId": "backend.firewall.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_FirewallCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.firewall" ] } ] } }, "/backend/firewall/{firewall_id}": { "get": { "tags": [ "firewall" ], "description": "Returns a specific firewall rule", "operationId": "backend.firewall.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Firewall" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.firewall" ] } ] }, "put": { "tags": [ "firewall" ], "description": "Updates an existing firewall rule", "operationId": "backend.firewall.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_FirewallUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.firewall" ] } ] }, "delete": { "tags": [ "firewall" ], "description": "Deletes an existing firewall rule", "operationId": "backend.firewall.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.firewall" ] } ] }, "parameters": [ { "name": "firewall_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/form": { "get": { "tags": [ "form" ], "description": "Returns a paginated list of forms", "operationId": "backend.form.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_FormCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.form" ] } ] }, "post": { "tags": [ "form" ], "description": "Creates a new form", "operationId": "backend.form.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_FormCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.form" ] } ] } }, "/backend/form/{form_id}": { "get": { "tags": [ "form" ], "description": "Returns a specific form", "operationId": "backend.form.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Form" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.form" ] } ] }, "put": { "tags": [ "form" ], "description": "Updates an existing form", "operationId": "backend.form.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_FormUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.form" ] } ] }, "delete": { "tags": [ "form" ], "description": "Deletes an existing form", "operationId": "backend.form.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.form" ] } ] }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/generator/{provider}": { "get": { "tags": [ "generator" ], "description": "Returns the generator config form", "operationId": "backend.generator.getForm", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_FormContainer" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.generator" ] } ] }, "put": { "tags": [ "generator" ], "description": "Generates a changelog of all potential changes if you execute this generator with the provided config", "operationId": "backend.generator.getChangelog", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_GeneratorProviderConfig" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_GeneratorProviderChangelog" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.generator" ] } ] }, "post": { "tags": [ "generator" ], "description": "Executes a generator with the provided config", "operationId": "backend.generator.executeProvider", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_GeneratorProvider" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.generator" ] } ] }, "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/generator": { "get": { "tags": [ "generator" ], "description": "Returns all available generator classes", "operationId": "backend.generator.getClasses", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_GeneratorIndexProviders" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.generator" ] } ] } }, "/backend/identity": { "get": { "tags": [ "identity" ], "description": "Returns a paginated list of identities", "operationId": "backend.identity.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_IdentityCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.identity" ] } ] }, "post": { "tags": [ "identity" ], "description": "Creates a new identity", "operationId": "backend.identity.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_IdentityCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.identity" ] } ] } }, "/backend/identity/{identity_id}": { "get": { "tags": [ "identity" ], "description": "Returns a specific identity", "operationId": "backend.identity.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Identity" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.identity" ] } ] }, "put": { "tags": [ "identity" ], "description": "Updates an existing identity", "operationId": "backend.identity.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_IdentityUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.identity" ] } ] }, "delete": { "tags": [ "identity" ], "description": "Deletes an existing identity", "operationId": "backend.identity.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.identity" ] } ] }, "parameters": [ { "name": "identity_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/identity/list": { "get": { "tags": [ "identity" ], "description": "Returns all available identity classes", "operationId": "backend.identity.getClasses", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_IdentityIndex" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.identity" ] } ] } }, "/backend/identity/form": { "get": { "tags": [ "identity" ], "description": "Returns the identity config form", "operationId": "backend.identity.getForm", "parameters": [ { "name": "class", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_FormContainer" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.identity" ] } ] } }, "/backend/log/{log_id}": { "get": { "tags": [ "log" ], "description": "Returns a specific log", "operationId": "backend.log.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Log" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.log" ] } ] }, "parameters": [ { "name": "log_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/log": { "get": { "tags": [ "log" ], "description": "Returns a paginated list of logs", "operationId": "backend.log.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "operationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userAgent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "header", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_LogCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.log" ] } ] } }, "/backend/log/error": { "get": { "tags": [ "log" ], "description": "Returns a paginated list of log errors", "operationId": "backend.log.getAllErrors", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_LogErrorCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.log" ] } ] } }, "/backend/log/error/{error_id}": { "get": { "tags": [ "log" ], "description": "Returns a specific error", "operationId": "backend.log.getError", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_LogError" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.log" ] } ] }, "parameters": [ { "name": "error_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/marketplace/action/{user}/{name}": { "get": { "tags": [ "marketplace" ], "description": "Returns a specific marketplace action", "operationId": "backend.marketplace.action.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceAction" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.marketplace" ] } ] }, "put": { "tags": [ "marketplace" ], "description": "Upgrades an action from the marketplace", "operationId": "backend.marketplace.action.upgrade", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.marketplace" ] } ] }, "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/marketplace/action": { "get": { "tags": [ "marketplace" ], "description": "Returns a paginated list of marketplace actions", "operationId": "backend.marketplace.action.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceActionCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.marketplace" ] } ] }, "post": { "tags": [ "marketplace" ], "description": "Installs an action from the marketplace", "operationId": "backend.marketplace.action.install", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceInstall" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceMessage" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.marketplace" ] } ] } }, "/backend/marketplace/app/{user}/{name}": { "get": { "tags": [ "marketplace" ], "description": "Returns a specific marketplace app", "operationId": "backend.marketplace.app.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceApp" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.marketplace" ] } ] }, "put": { "tags": [ "marketplace" ], "description": "Upgrades an app from the marketplace", "operationId": "backend.marketplace.app.upgrade", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceMessage" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.marketplace" ] } ] }, "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/marketplace/app": { "get": { "tags": [ "marketplace" ], "description": "Returns a paginated list of marketplace apps", "operationId": "backend.marketplace.app.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceAppCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.marketplace" ] } ] }, "post": { "tags": [ "marketplace" ], "description": "Installs an app from the marketplace", "operationId": "backend.marketplace.app.install", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceInstall" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceMessage" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.marketplace" ] } ] } }, "/backend/marketplace/bundle/{user}/{name}": { "get": { "tags": [ "marketplace" ], "description": "Returns a specific marketplace bundle", "operationId": "backend.marketplace.bundle.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceBundle" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.marketplace" ] } ] }, "put": { "tags": [ "marketplace" ], "description": "Upgrades an bundle from the marketplace", "operationId": "backend.marketplace.bundle.upgrade", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceMessage" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.marketplace" ] } ] }, "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/marketplace/bundle": { "get": { "tags": [ "marketplace" ], "description": "Returns a paginated list of marketplace bundles", "operationId": "backend.marketplace.bundle.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceBundleCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.marketplace" ] } ] }, "post": { "tags": [ "marketplace" ], "description": "Installs an bundle from the marketplace", "operationId": "backend.marketplace.bundle.install", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceInstall" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceMessage" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.marketplace" ] } ] } }, "/backend/operation": { "get": { "tags": [ "operation" ], "description": "Returns a paginated list of operations", "operationId": "backend.operation.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "taxonomy", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_OperationCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.operation" ] } ] }, "post": { "tags": [ "operation" ], "description": "Creates a new operation", "operationId": "backend.operation.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_OperationCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.operation" ] } ] } }, "/backend/operation/{operation_id}": { "get": { "tags": [ "operation" ], "description": "Returns a specific operation", "operationId": "backend.operation.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Operation" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.operation" ] } ] }, "put": { "tags": [ "operation" ], "description": "Updates an existing operation", "operationId": "backend.operation.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_OperationUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.operation" ] } ] }, "delete": { "tags": [ "operation" ], "description": "Deletes an existing operation", "operationId": "backend.operation.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.operation" ] } ] }, "parameters": [ { "name": "operation_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/page": { "get": { "tags": [ "page" ], "description": "Returns a paginated list of pages", "operationId": "backend.page.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_PageCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.page" ] } ] }, "post": { "tags": [ "page" ], "description": "Creates a new page", "operationId": "backend.page.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_PageCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.page" ] } ] } }, "/backend/page/{page_id}": { "get": { "tags": [ "page" ], "description": "Returns a specific page", "operationId": "backend.page.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Page" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.page" ] } ] }, "put": { "tags": [ "page" ], "description": "Updates an existing page", "operationId": "backend.page.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_PageUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.page" ] } ] }, "delete": { "tags": [ "page" ], "description": "Deletes an existing page", "operationId": "backend.page.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.page" ] } ] }, "parameters": [ { "name": "page_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/plan": { "get": { "tags": [ "plan" ], "description": "Returns a paginated list of plans", "operationId": "backend.plan.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_PlanCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.plan" ] } ] }, "post": { "tags": [ "plan" ], "description": "Creates a new plan", "operationId": "backend.plan.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_PlanCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.plan" ] } ] } }, "/backend/plan/{plan_id}": { "get": { "tags": [ "plan" ], "description": "Returns a specific plan", "operationId": "backend.plan.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Plan" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.plan" ] } ] }, "put": { "tags": [ "plan" ], "description": "Updates an existing plan", "operationId": "backend.plan.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_PlanUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.plan" ] } ] }, "delete": { "tags": [ "plan" ], "description": "Deletes an existing plan", "operationId": "backend.plan.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.plan" ] } ] }, "parameters": [ { "name": "plan_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/rate": { "get": { "tags": [ "rate" ], "description": "Returns a paginated list of rate limitations", "operationId": "backend.rate.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_RateCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.rate" ] } ] }, "post": { "tags": [ "rate" ], "description": "Creates a new rate limitation", "operationId": "backend.rate.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_RateCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.rate" ] } ] } }, "/backend/rate/{rate_id}": { "get": { "tags": [ "rate" ], "description": "Returns a specific rate", "operationId": "backend.rate.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Rate" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.rate" ] } ] }, "put": { "tags": [ "rate" ], "description": "Updates an existing rate", "operationId": "backend.rate.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_RateUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.rate" ] } ] }, "delete": { "tags": [ "rate" ], "description": "Deletes an existing rate", "operationId": "backend.rate.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.rate" ] } ] }, "parameters": [ { "name": "rate_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/role": { "get": { "tags": [ "role" ], "description": "Returns a paginated list of roles", "operationId": "backend.role.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_RoleCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.role" ] } ] }, "post": { "tags": [ "role" ], "description": "Creates a new role", "operationId": "backend.role.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_RoleCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.role" ] } ] } }, "/backend/role/{role_id}": { "get": { "tags": [ "role" ], "description": "Returns a specific role", "operationId": "backend.role.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Role" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.role" ] } ] }, "put": { "tags": [ "role" ], "description": "Updates an existing role", "operationId": "backend.role.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_RoleUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.role" ] } ] }, "delete": { "tags": [ "role" ], "description": "Deletes an existing role", "operationId": "backend.role.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.role" ] } ] }, "parameters": [ { "name": "role_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/schema": { "get": { "tags": [ "schema" ], "description": "Returns a paginated list of schemas", "operationId": "backend.schema.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "taxonomy", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_SchemaCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.schema" ] } ] }, "post": { "tags": [ "schema" ], "description": "Creates a new schema", "operationId": "backend.schema.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_SchemaCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.schema" ] } ] } }, "/backend/schema/{schema_id}": { "get": { "tags": [ "schema" ], "description": "Returns a specific schema", "operationId": "backend.schema.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Schema" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.schema" ] } ] }, "put": { "tags": [ "schema" ], "description": "Updates an existing schema", "operationId": "backend.schema.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_SchemaUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.schema" ] } ] }, "delete": { "tags": [ "schema" ], "description": "Deletes an existing schema", "operationId": "backend.schema.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.schema" ] } ] }, "parameters": [ { "name": "schema_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/schema/{schema_id}/commit": { "get": { "tags": [ "schema" ], "description": "Returns a paginated list of schema commits", "operationId": "backend.schema.getCommits", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_SchemaCommitCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.schema" ] } ] }, "parameters": [ { "name": "schema_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/schema/preview/{schema_id}": { "post": { "tags": [ "schema" ], "description": "Returns a HTML preview of the provided schema", "operationId": "backend.schema.getPreview", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_SchemaPreviewResponse" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.schema" ] } ] }, "parameters": [ { "name": "schema_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/scope": { "get": { "tags": [ "scope" ], "description": "Returns a paginated list of scopes", "operationId": "backend.scope.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_ScopeCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.scope" ] } ] }, "post": { "tags": [ "scope" ], "description": "Creates a new scope", "operationId": "backend.scope.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_ScopeCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.scope" ] } ] } }, "/backend/scope/{scope_id}": { "get": { "tags": [ "scope" ], "description": "Returns a specific scope", "operationId": "backend.scope.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Scope" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.scope" ] } ] }, "put": { "tags": [ "scope" ], "description": "Updates an existing scope", "operationId": "backend.scope.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_ScopeUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.scope" ] } ] }, "delete": { "tags": [ "scope" ], "description": "Deletes an existing scope", "operationId": "backend.scope.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.scope" ] } ] }, "parameters": [ { "name": "scope_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/scope/categories": { "get": { "tags": [ "scope" ], "description": "Returns all available scopes grouped by category", "operationId": "backend.scope.getCategories", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_ScopeCategories" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.scope" ] } ] } }, "/backend/sdk": { "get": { "tags": [ "sdk" ], "description": "Returns a paginated list of SDKs", "operationId": "backend.sdk.getAll", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_SdkResponse" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.sdk" ] } ] }, "post": { "tags": [ "sdk" ], "description": "Generates a specific SDK", "operationId": "backend.sdk.generate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_SdkGenerate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_SdkMessage" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.sdk" ] } ] } }, "/backend/specification": { "get": { "tags": [ "specification" ], "description": "Returns the TypeHub specification", "operationId": "backend.specification.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_SpecificationGet" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.specification" ] } ] }, "post": { "tags": [ "specification" ], "description": "Publish the specification", "operationId": "backend.specification.publish", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_SpecificationPublish" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.specification" ] } ] } }, "/backend/specification/changelog": { "get": { "tags": [ "specification" ], "description": "Returns the changelog between your current specification and the last tag", "operationId": "backend.specification.getChangelog", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_SpecificationChangelog" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.specification" ] } ] } }, "/backend/specification/tag": { "post": { "tags": [ "specification" ], "description": "Creates a new tag of your specification", "operationId": "backend.specification.tag", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Passthru" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.specification" ] } ] } }, "/backend/statistic/activities_per_user": { "get": { "tags": [ "statistic" ], "description": "Returns a statistic containing the activities per user", "operationId": "backend.statistic.getActivitiesPerUser", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "operationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userAgent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "header", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_StatisticChart" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.statistic" ] } ] } }, "/backend/statistic/count_requests": { "get": { "tags": [ "statistic" ], "description": "Returns a statistic containing the request count", "operationId": "backend.statistic.getCountRequests", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "operationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userAgent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "header", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_StatisticCount" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.statistic" ] } ] } }, "/backend/statistic/errors_per_operation": { "get": { "tags": [ "statistic" ], "description": "Returns a statistic containing the errors per operation", "operationId": "backend.statistic.getErrorsPerOperation", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "operationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userAgent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "header", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_StatisticChart" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.statistic" ] } ] } }, "/backend/statistic/incoming_requests": { "get": { "tags": [ "statistic" ], "description": "Returns a statistic containing the incoming requests", "operationId": "backend.statistic.getIncomingRequests", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "operationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userAgent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "header", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_StatisticChart" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.statistic" ] } ] } }, "/backend/statistic/incoming_transactions": { "get": { "tags": [ "statistic" ], "description": "Returns a statistic containing the incoming transactions", "operationId": "backend.statistic.getIncomingTransactions", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "operationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userAgent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "header", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_StatisticChart" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.statistic" ] } ] } }, "/backend/statistic/issued_tokens": { "get": { "tags": [ "statistic" ], "description": "Returns a statistic containing the issues tokens", "operationId": "backend.statistic.getIssuedTokens", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "operationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userAgent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "header", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_StatisticChart" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.statistic" ] } ] } }, "/backend/statistic/most_used_activities": { "get": { "tags": [ "statistic" ], "description": "Returns a statistic containing the most used activities", "operationId": "backend.statistic.getMostUsedActivities", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "operationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userAgent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "header", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_StatisticChart" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.statistic" ] } ] } }, "/backend/statistic/most_used_apps": { "get": { "tags": [ "statistic" ], "description": "Returns a statistic containing the most used apps", "operationId": "backend.statistic.getMostUsedApps", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "operationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userAgent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "header", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_StatisticChart" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.statistic" ] } ] } }, "/backend/statistic/most_used_operations": { "get": { "tags": [ "statistic" ], "description": "Returns a statistic containing the most used operations", "operationId": "backend.statistic.getMostUsedOperations", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "operationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userAgent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "header", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_StatisticChart" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.statistic" ] } ] } }, "/backend/statistic/requests_per_ip": { "get": { "tags": [ "statistic" ], "description": "Returns a statistic containing the requests per ip", "operationId": "backend.statistic.getRequestsPerIP", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "operationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userAgent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "header", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_StatisticChart" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.statistic" ] } ] } }, "/backend/statistic/requests_per_operation": { "get": { "tags": [ "statistic" ], "description": "Returns a statistic containing the requests per operation", "operationId": "backend.statistic.getRequestsPerOperation", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "operationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userAgent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "header", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_StatisticChart" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.statistic" ] } ] } }, "/backend/statistic/requests_per_user": { "get": { "tags": [ "statistic" ], "description": "Returns a statistic containing the requests per user", "operationId": "backend.statistic.getRequestsPerUser", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "operationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userAgent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "header", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_StatisticChart" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.statistic" ] } ] } }, "/backend/statistic/test_coverage": { "get": { "tags": [ "statistic" ], "description": "Returns a statistic containing the test coverage", "operationId": "backend.statistic.getTestCoverage", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_StatisticChart" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.statistic" ] } ] } }, "/backend/statistic/time_average": { "get": { "tags": [ "statistic" ], "description": "Returns a statistic containing the time average", "operationId": "backend.statistic.getTimeAverage", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "operationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userAgent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "header", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_StatisticChart" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.statistic" ] } ] } }, "/backend/statistic/time_per_operation": { "get": { "tags": [ "statistic" ], "description": "Returns a statistic containing the time per operation", "operationId": "backend.statistic.getTimePerOperation", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "operationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userAgent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "header", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_StatisticChart" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.statistic" ] } ] } }, "/backend/statistic/used_points": { "get": { "tags": [ "statistic" ], "description": "Returns a statistic containing the used points", "operationId": "backend.statistic.getUsedPoints", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "operationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userAgent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "header", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_StatisticChart" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.statistic" ] } ] } }, "/backend/statistic/user_registrations": { "get": { "tags": [ "statistic" ], "description": "Returns a statistic containing the user registrations", "operationId": "backend.statistic.getUserRegistrations", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "operationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userAgent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "header", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_StatisticChart" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.statistic" ] } ] } }, "/backend/taxonomy": { "get": { "tags": [ "taxonomy" ], "description": "Returns a paginated list of taxonomies", "operationId": "backend.taxonomy.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_TaxonomyCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.taxonomy" ] } ] }, "post": { "tags": [ "taxonomy" ], "description": "Creates a new taxonomy", "operationId": "backend.taxonomy.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_TaxonomyCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.taxonomy" ] } ] } }, "/backend/taxonomy/{taxonomy_id}": { "get": { "tags": [ "taxonomy" ], "description": "Returns a specific taxonomy", "operationId": "backend.taxonomy.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Taxonomy" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.taxonomy" ] } ] }, "put": { "tags": [ "taxonomy" ], "description": "Updates an existing taxonomy", "operationId": "backend.taxonomy.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_TaxonomyUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.taxonomy" ] } ] }, "post": { "tags": [ "taxonomy" ], "description": "Moves the provided ids to the taxonomy", "operationId": "backend.taxonomy.move", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_TaxonomyMove" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.taxonomy" ] } ] }, "delete": { "tags": [ "taxonomy" ], "description": "Deletes an existing taxonomy", "operationId": "backend.taxonomy.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.taxonomy" ] } ] }, "parameters": [ { "name": "taxonomy_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/tenant/{tenant_id}": { "put": { "tags": [ "tenant" ], "description": "Setup a new tenant", "operationId": "backend.tenant.setup", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.tenant" ] } ] }, "delete": { "tags": [ "tenant" ], "description": "Removes an existing tenant", "operationId": "backend.tenant.remove", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.tenant" ] } ] }, "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/test/{test_id}": { "get": { "tags": [ "test" ], "description": "Returns a specific test", "operationId": "backend.test.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Test" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.test" ] } ] }, "put": { "tags": [ "test" ], "description": "Updates an existing test", "operationId": "backend.test.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Test" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.test" ] } ] }, "parameters": [ { "name": "test_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/test": { "get": { "tags": [ "test" ], "description": "Returns a paginated list of tests", "operationId": "backend.test.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_TestCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.test" ] } ] }, "put": { "tags": [ "test" ], "description": "Refresh all tests", "operationId": "backend.test.refresh", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.test" ] } ] }, "post": { "tags": [ "test" ], "description": "Run all tests", "operationId": "backend.test.run", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.test" ] } ] } }, "/backend/token/{token_id}": { "get": { "tags": [ "token" ], "description": "Returns a specific token", "operationId": "backend.token.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Token" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.token" ] } ] }, "parameters": [ { "name": "token_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/token": { "get": { "tags": [ "token" ], "description": "Returns a paginated list of tokens", "operationId": "backend.token.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "scope", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_TokenCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.token" ] } ] } }, "/backend/transaction/{transaction_id}": { "get": { "tags": [ "transaction" ], "description": "Returns a specific transaction", "operationId": "backend.transaction.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Transaction" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.transaction" ] } ] }, "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/transaction": { "get": { "tags": [ "transaction" ], "description": "Returns a paginated list of transactions", "operationId": "backend.transaction.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "planId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "provider", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "taxonomy", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_TransactionCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.transaction" ] } ] } }, "/backend/trash/{type}": { "get": { "tags": [ "trash" ], "description": "Returns all deleted records by trash type", "operationId": "backend.trash.getAllByType", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_TrashDataCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.trash" ] } ] }, "post": { "tags": [ "trash" ], "description": "Restores a previously deleted record", "operationId": "backend.trash.restore", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_TrashRestore" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.trash" ] } ] }, "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/trash": { "get": { "tags": [ "trash" ], "description": "Returns all trash types", "operationId": "backend.trash.getTypes", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_TrashTypes" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.trash" ] } ] } }, "/backend/trigger": { "get": { "tags": [ "trigger" ], "description": "Returns a paginated list of triggers", "operationId": "backend.trigger.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "taxonomy", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_TriggerCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.trigger" ] } ] }, "post": { "tags": [ "trigger" ], "description": "Creates a new trigger", "operationId": "backend.trigger.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_TriggerCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.trigger" ] } ] } }, "/backend/trigger/{trigger_id}": { "get": { "tags": [ "trigger" ], "description": "Returns a specific trigger", "operationId": "backend.trigger.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Trigger" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.trigger" ] } ] }, "put": { "tags": [ "trigger" ], "description": "Updates an existing trigger", "operationId": "backend.trigger.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_TriggerUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.trigger" ] } ] }, "delete": { "tags": [ "trigger" ], "description": "Deletes an existing trigger", "operationId": "backend.trigger.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.trigger" ] } ] }, "parameters": [ { "name": "trigger_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/user": { "get": { "tags": [ "user" ], "description": "Returns a paginated list of users", "operationId": "backend.user.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_UserCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.user" ] } ] }, "post": { "tags": [ "user" ], "description": "Creates a new user", "operationId": "backend.user.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_UserCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.user" ] } ] } }, "/backend/user/{user_id}": { "get": { "tags": [ "user" ], "description": "Returns a specific user", "operationId": "backend.user.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_User" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.user" ] } ] }, "put": { "tags": [ "user" ], "description": "Updates an existing user", "operationId": "backend.user.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_UserUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.user" ] } ] }, "delete": { "tags": [ "user" ], "description": "Deletes an existing user", "operationId": "backend.user.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.user" ] } ] }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/user/{user_id}/resend": { "post": { "tags": [ "user" ], "description": "Resend the activation mail to the provided user", "operationId": "backend.user.resend", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Passthru" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.user" ] } ] }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/backend/webhook": { "get": { "tags": [ "webhook" ], "description": "Returns a paginated list of webhooks", "operationId": "backend.webhook.getAll", "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_WebhookCollection" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.webhook" ] } ] }, "post": { "tags": [ "webhook" ], "description": "Creates a new webhook", "operationId": "backend.webhook.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_WebhookCreate" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.webhook" ] } ] } }, "/backend/webhook/{webhook_id}": { "get": { "tags": [ "webhook" ], "description": "Returns a specific webhook", "operationId": "backend.webhook.get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_Webhook" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.webhook" ] } ] }, "put": { "tags": [ "webhook" ], "description": "Updates an existing webhook", "operationId": "backend.webhook.update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backend_WebhookUpdate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.webhook" ] } ] }, "delete": { "tags": [ "webhook" ], "description": "Deletes an existing webhook", "operationId": "backend.webhook.delete", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "4XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } }, "5XX": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common_Message" } } } } }, "security": [ { "app": [ "backend.webhook" ] } ] }, "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "components": { "schemas": { "Agent_Input": { "description": "This object represents an agent input", "type": "object", "properties": { "previousId": { "description": "Optional the chat id of this conversation", "type": "string" }, "item": { "$ref": "#/components/schemas/Agent_Item" } } }, "Agent_Item": { "oneOf": [ { "$ref": "#/components/schemas/Agent_ItemBinary" }, { "$ref": "#/components/schemas/Agent_ItemChoice" }, { "$ref": "#/components/schemas/Agent_ItemObject" }, { "$ref": "#/components/schemas/Agent_ItemText" }, { "$ref": "#/components/schemas/Agent_ItemToolCall" } ], "discriminator": "type", "mapping": { "binary": "#/components/schemas/Agent_ItemBinary", "choice": "#/components/schemas/Agent_ItemChoice", "object": "#/components/schemas/Agent_ItemObject", "text": "#/components/schemas/Agent_ItemText", "tool_call": "#/components/schemas/Agent_ItemToolCall" } }, "Agent_ItemBinary": { "allOf": [ { "$ref": "#/components/schemas/Agent_Item" }, { "description": "Binary agent message", "type": "object", "properties": { "mime": { "description": "The mime of the binary data", "type": "string" }, "data": { "description": "The base64 encoded binary data", "type": "string" } } } ] }, "Agent_ItemChoice": { "allOf": [ { "$ref": "#/components/schemas/Agent_Item" }, { "description": "Choice agent message", "type": "object", "properties": { "items": { "description": "Contains multiple agent items", "type": "array", "items": { "$ref": "#/components/schemas/Agent_Item" } } } } ] }, "Agent_ItemObject": { "allOf": [ { "$ref": "#/components/schemas/Agent_Item" }, { "description": "Structured agent message", "type": "object", "properties": { "payload": {} } } ] }, "Agent_ItemText": { "allOf": [ { "$ref": "#/components/schemas/Agent_Item" }, { "description": "Text agent message", "type": "object", "properties": { "content": { "description": "The content text", "type": "string" } } } ] }, "Agent_ItemToolCall": { "allOf": [ { "$ref": "#/components/schemas/Agent_Item" }, { "description": "Tool call agent message", "type": "object", "properties": { "functions": { "description": "An array of concrete functions", "type": "array", "items": { "$ref": "#/components/schemas/Agent_ItemToolCallFunction" } } } } ] }, "Agent_ItemToolCallFunction": { "description": "Concrete values for a function tool call", "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "arguments": { "type": "string" } } }, "Agent_Output": { "description": "This object represents an agent output", "type": "object", "properties": { "id": { "description": "Chat id of this conversation", "type": "string" }, "item": { "$ref": "#/components/schemas/Agent_Item" } } }, "Backend_AccountChangePassword": { "type": "object", "properties": { "oldPassword": { "description": "The old password", "type": "string" }, "newPassword": { "description": "The new password", "type": "string" }, "verifyPassword": { "description": "To verify the new password must contain the same value as the new password", "type": "string" } } }, "Backend_Action": { "description": "This object represents the business logic which can be executed either through an operation or cronjob", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "status": { "description": "Status of the object either 1 = active or 0 = deleted", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "class": { "description": "Underlying class of this action which handles the action logic", "type": "string" }, "async": { "description": "Whether to execute the action asynchronously, if true the action directly returns a 202 response and the action is executed later on in the background, useful for expensive operations", "type": "boolean" }, "config": { "$ref": "#/components/schemas/Backend_ActionConfig" }, "metadata": { "$ref": "#/components/schemas/Common_Metadata" } } }, "Backend_ActionCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Action" } } } }, "Backend_ActionCommit": { "description": "An action commit which represents a change in the action configuration", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "user": { "$ref": "#/components/schemas/Backend_User" }, "commitHash": { "description": "A unique hash which represents this commit", "type": "string" }, "config": { "$ref": "#/components/schemas/Backend_ActionConfig" }, "insertDate": { "type": "string", "format": "date-time" } } }, "Backend_ActionCommitCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_ActionCommit" } } } }, "Backend_ActionConfig": { "description": "The action configuration which contains arbitrary key-value entries", "type": "object", "additionalProperties": {} }, "Backend_ActionCreate": { "$ref": "#/components/schemas/Backend_Action" }, "Backend_ActionExecuteRequest": { "description": "Represents a request to execute an action", "type": "object", "properties": { "method": { "description": "HTTP method i.e. GET, POST", "type": "string" }, "uriFragments": { "description": "URL-encoded uri fragments i.e. foo=bar&bar=foo", "type": "string" }, "parameters": { "description": "URL-encoded query parameters i.e. foo=bar&bar=foo", "type": "string" }, "headers": { "description": "URL-encoded headers i.e. foo=bar&bar=foo", "type": "string" }, "body": { "$ref": "#/components/schemas/Backend_ActionExecuteRequestBody" } } }, "Backend_ActionExecuteRequestBody": { "description": "Represents a request body", "type": "object", "additionalProperties": {} }, "Backend_ActionExecuteResponse": { "description": "Represents an action execution response", "type": "object", "properties": { "statusCode": { "description": "HTTP status code i.e. 200, 400, etc.", "type": "integer" }, "headers": { "$ref": "#/components/schemas/Backend_ActionExecuteResponseHeaders" }, "body": { "$ref": "#/components/schemas/Backend_ActionExecuteResponseBody" } } }, "Backend_ActionExecuteResponseBody": { "description": "Represents a response body", "type": "object", "additionalProperties": {} }, "Backend_ActionExecuteResponseHeaders": { "description": "Represents a map of headers", "type": "object", "additionalProperties": { "type": "string" } }, "Backend_ActionIndex": { "description": "Contains all possible classes which can be used at an action as class", "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_ActionIndexEntry" } } } }, "Backend_ActionIndexEntry": { "description": "Represents a concrete action class", "type": "object", "properties": { "name": { "description": "Human-readable name of the action class", "type": "string" }, "class": { "description": "Technical identifier of the action class", "type": "string" } } }, "Backend_ActionUpdate": { "$ref": "#/components/schemas/Backend_Action" }, "Backend_Agent": { "description": "This object represents an agent", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "connection": { "description": "The agent connection which should be used", "type": "integer" }, "type": { "description": "The agent type", "type": "integer" }, "public": { "description": "Indicates whether the agent is public", "type": "boolean" }, "name": { "description": "Name of the agent", "type": "string" }, "description": { "description": "Description of the agent", "type": "string" }, "introduction": { "description": "Introduction message", "type": "string" }, "temperature": { "description": "The used temperature default is 1.0", "type": "number" }, "costs": { "description": "Costs per token", "type": "integer" }, "tools": { "description": "Tools available to this agent", "type": "array", "items": { "type": "string" } }, "outgoing": { "description": "Describes the outgoing response payload, this must contain a schema name", "type": "string" }, "action": { "description": "Action which gets invoked for each generated response", "type": "string" }, "insertDate": { "type": "string", "format": "date-time" }, "metadata": { "$ref": "#/components/schemas/Common_Metadata" } } }, "Backend_AgentCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Agent" } } } }, "Backend_AgentCreate": { "$ref": "#/components/schemas/Backend_Agent" }, "Backend_AgentMessage": { "description": "This object represents an agent message", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "chatId": { "description": "The assigned chat id which can be used to load the complete conversation", "type": "string" }, "role": { "description": "The role of this message i.e. user, assistant or system", "type": "string" }, "item": { "$ref": "#/components/schemas/Agent_Item" }, "insertDate": { "type": "string", "format": "date-time" } } }, "Backend_AgentMessageCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_AgentMessage" } } } }, "Backend_AgentTool": { "description": "Represents a concrete tool", "type": "object", "properties": { "name": { "description": "Name of the tool", "type": "string" }, "description": { "description": "Description of the tool", "type": "string" } } }, "Backend_AgentTools": { "description": "Represents a collection of available tools", "type": "object", "properties": { "tools": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_AgentTool" } } } }, "Backend_AgentUpdate": { "$ref": "#/components/schemas/Backend_Agent" }, "Backend_App": { "description": "This object represents an app to access the API on-behalf of a user", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "userId": { "type": "integer" }, "status": { "description": "Status of the object either 1 = active, 2 = pending, 3 = deactivated or 4 = deleted", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "url": { "description": "Url where the app is hosted", "type": "string" }, "parameters": { "description": "Optional URL-encoded parameters of the app i.e. foo=bar&bar=foo", "type": "string" }, "appKey": { "description": "The app key also known as client id which is generated on creation", "type": "string" }, "appSecret": { "description": "The app secret also known as client secret which is generated on creation", "type": "string" }, "metadata": { "$ref": "#/components/schemas/Common_Metadata" }, "date": { "description": "The create date of this object", "type": "string", "format": "date-time" }, "scopes": { "description": "A list of assigned scopes for this app", "type": "array", "items": { "type": "string" } }, "tokens": { "description": "A list of tokens which are assigned to this app", "type": "array", "items": { "$ref": "#/components/schemas/Backend_Token" } } } }, "Backend_AppCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_App" } } } }, "Backend_AppCreate": { "$ref": "#/components/schemas/Backend_App" }, "Backend_AppUpdate": { "$ref": "#/components/schemas/Backend_App" }, "Backend_Audit": { "description": "This object represents an audit which is created every time something was changed at the system", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "app": { "$ref": "#/components/schemas/Backend_App" }, "user": { "$ref": "#/components/schemas/Backend_User" }, "event": { "description": "Trigger event of this audit", "type": "string" }, "ip": { "description": "IP which as issued the request", "type": "string" }, "message": { "description": "Message of this audit event", "type": "string" }, "content": { "$ref": "#/components/schemas/Backend_AuditObject" }, "date": { "description": "Insert date of this audit event", "type": "string", "format": "date-time" } } }, "Backend_AuditCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Audit" } } } }, "Backend_AuditObject": { "description": "A key value object containing the changes", "type": "object", "additionalProperties": {} }, "Backend_BackupExport": { "description": "Export of the complete system configuration", "type": "object", "properties": { "export": { "type": "string" } } }, "Backend_BackupImport": { "description": "Import a previously exported system configuration", "type": "object", "properties": { "import": { "type": "string" } } }, "Backend_BackupImportResult": { "description": "Result of a backup import operation", "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "logs": { "type": "array", "items": { "type": "string" } } } }, "Backend_Bundle": { "description": "This object represents a bundle which contains action, schema, event, cronjob and trigger configurations from you local instance", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "version": { "description": "Version of this bundle", "type": "string" }, "icon": { "description": "Icon to represent this bundle", "type": "string" }, "summary": { "description": "Short summary which explains the use case for this bundle", "type": "string" }, "description": { "description": "Long description how to use this bundle may also contains markdown syntax", "type": "string" }, "cost": { "description": "Optional a cost for this bundle", "type": "integer" }, "config": { "$ref": "#/components/schemas/Backend_BundleConfig" } } }, "Backend_BundleCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Bundle" } } } }, "Backend_BundleConfig": { "type": "object", "additionalProperties": {} }, "Backend_BundleCreate": { "$ref": "#/components/schemas/Backend_Bundle" }, "Backend_BundleUpdate": { "$ref": "#/components/schemas/Backend_Bundle" }, "Backend_Category": { "description": "This object represents a category. Every user is assigned to a category and can only view objects which are also assigned to the same category, through this it is possible to build separate areas for external developers", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" } } }, "Backend_CategoryCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Category" } } } }, "Backend_CategoryCreate": { "$ref": "#/components/schemas/Backend_Category" }, "Backend_CategoryUpdate": { "$ref": "#/components/schemas/Backend_Category" }, "Backend_Config": { "description": "This object represents a system configuration", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "type": { "description": "The config value type", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "description": { "description": "A short description fo this configuration value", "type": "string" }, "value": {} } }, "Backend_ConfigCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Config" } } } }, "Backend_ConfigUpdate": { "$ref": "#/components/schemas/Backend_Config" }, "Backend_Connection": { "description": "This object represents a connection to an external system like i.e. a database, message-queue or client-sdk", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "class": { "description": "Underlying class of this connection which returns a configured client connection i.e. database, message-queue or client-sdk", "type": "string" }, "oauth2": { "description": "Indicates whether it is possible to start an OAuth2 authorization code flow on this connection", "type": "boolean" }, "config": { "$ref": "#/components/schemas/Backend_ConnectionConfig" }, "metadata": { "$ref": "#/components/schemas/Common_Metadata" } } }, "Backend_ConnectionCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Connection" } } } }, "Backend_ConnectionConfig": { "description": "The connection configuration which contains arbitrary key-value entries", "type": "object", "additionalProperties": {} }, "Backend_ConnectionCreate": { "$ref": "#/components/schemas/Backend_Connection" }, "Backend_ConnectionIndex": { "description": "Contains all possible classes which can be used at an connection as class", "type": "object", "properties": { "connections": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_ConnectionIndexEntry" } } } }, "Backend_ConnectionIndexEntry": { "description": "Represents a concrete connection class", "type": "object", "properties": { "name": { "description": "Human-readable name of the connection class", "type": "string" }, "class": { "description": "Technical identifier of the connection class", "type": "string" } } }, "Backend_ConnectionRedirectResponse": { "description": "Redirect response to initiate an OAuth2 flow", "type": "object", "properties": { "redirectUri": { "type": "string" } } }, "Backend_ConnectionUpdate": { "$ref": "#/components/schemas/Backend_Connection" }, "Backend_Cronjob": { "description": "This object represents a cronjob which can invoke an action at a specific interval", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "cron": { "description": "The cron expression i.e. */5 * * * * for every 5 minutes", "type": "string" }, "action": { "description": "The target action which gets invoked", "type": "string" }, "executeDate": { "description": "The last execution date", "type": "string", "format": "date-time" }, "exitCode": { "description": "The last exit code", "type": "integer" }, "metadata": { "$ref": "#/components/schemas/Common_Metadata" }, "errors": { "description": "Contains an array of errors in case the cronjob has failed", "type": "array", "items": { "$ref": "#/components/schemas/Backend_CronjobError" } } } }, "Backend_CronjobCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Cronjob" } } } }, "Backend_CronjobCreate": { "$ref": "#/components/schemas/Backend_Cronjob" }, "Backend_CronjobError": { "description": "Represents an error which occurred on cronjob execution", "type": "object", "properties": { "message": { "type": "string" }, "trace": { "type": "string" }, "file": { "type": "string" }, "line": { "type": "integer" } } }, "Backend_CronjobUpdate": { "$ref": "#/components/schemas/Backend_Cronjob" }, "Backend_Dashboard": { "description": "Represents an object containing all widget data for the dashboard", "type": "object", "properties": { "errorsPerOperation": { "$ref": "#/components/schemas/Backend_StatisticChart" }, "incomingRequests": { "$ref": "#/components/schemas/Backend_StatisticChart" }, "incomingTransactions": { "$ref": "#/components/schemas/Backend_StatisticChart" }, "mostUsedOperations": { "$ref": "#/components/schemas/Backend_StatisticChart" }, "timePerOperation": { "$ref": "#/components/schemas/Backend_StatisticChart" }, "testCoverage": { "$ref": "#/components/schemas/Backend_StatisticChart" }, "mostUsedActivities": { "$ref": "#/components/schemas/Backend_StatisticChart" }, "activitiesPerUser": { "$ref": "#/components/schemas/Backend_StatisticChart" }, "userRegistrations": { "$ref": "#/components/schemas/Backend_StatisticChart" } } }, "Backend_DatabaseRow": { "description": "This object represents a row on a relational table", "type": "object", "additionalProperties": {} }, "Backend_DatabaseRowCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_DatabaseRow" } } } }, "Backend_DatabaseTable": { "description": "This object represents a relational table on a database connection", "type": "object", "properties": { "name": { "description": "Name of the table", "type": "string" }, "columns": { "description": "Available columns on the table", "type": "array", "items": { "$ref": "#/components/schemas/Backend_DatabaseTableColumn" } }, "primaryKey": { "description": "The primary key column", "type": "string" }, "indexes": { "description": "Available indices on the table", "type": "array", "items": { "$ref": "#/components/schemas/Backend_DatabaseTableIndex" } }, "foreignKeys": { "description": "Available foreign key constraints", "type": "array", "items": { "$ref": "#/components/schemas/Backend_DatabaseTableForeignKeyConstraint" } } } }, "Backend_DatabaseTableCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_DatabaseTable" } } } }, "Backend_DatabaseTableColumn": { "description": "This object represents a column at a relation table", "type": "object", "properties": { "name": { "description": "Name of the column", "type": "string" }, "type": { "description": "The column type i.e. integer or string", "type": "string" }, "length": { "description": "Optional the max length of the column", "type": "integer" }, "precision": { "description": "Optional the precision of the column", "type": "integer" }, "scale": { "description": "Optional the scale of the column", "type": "integer" }, "unsigned": { "description": "Indicates whether the column is unsigned, relevant for integer types", "type": "boolean" }, "fixed": { "description": "Indicates whether the column has a fixed length", "type": "boolean" }, "notNull": { "description": "Indicates whether the column allows null", "type": "boolean" }, "autoIncrement": { "description": "Indicates whether this column is an auto increment column", "type": "boolean" }, "default": {}, "comment": { "description": "Optional a comment for this column", "type": "string" } } }, "Backend_DatabaseTableForeignKeyConstraint": { "description": "This object represents a foreign key constraint on a relational database", "type": "object", "properties": { "name": { "description": "Name of the foreign key constraint", "type": "string" }, "foreignTable": { "description": "Name of the foreign table", "type": "string" }, "localColumnNames": { "description": "Local column names", "type": "array", "items": { "type": "string" } }, "foreignColumnNames": { "description": "Foreign column names", "type": "array", "items": { "type": "string" } } } }, "Backend_DatabaseTableIndex": { "description": "This object represents a table index on a relational database", "type": "object", "properties": { "name": { "description": "Name of the index", "type": "string" }, "unique": { "description": "Indicates whether the index is unique", "type": "boolean" }, "columns": { "description": "Columns assigned ot the index", "type": "array", "items": { "type": "string" } } } }, "Backend_Event": { "description": "This object represents an event which can be triggered by an action", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "description": { "type": "string" }, "schema": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Common_Metadata" } } }, "Backend_EventCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Event" } } } }, "Backend_EventCreate": { "$ref": "#/components/schemas/Backend_Event" }, "Backend_EventUpdate": { "$ref": "#/components/schemas/Backend_Event" }, "Backend_File": { "description": "This object represents a file on the filesystem", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "string" }, "name": { "description": "Name of the file", "type": "string" }, "contentType": { "description": "MIME type of the file", "type": "string" }, "checksum": { "description": "Checksum of the file", "type": "string" }, "lastModified": { "description": "Last modified date of the file", "type": "string", "format": "date-time" } } }, "Backend_FileCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_File" } } } }, "Backend_Firewall": { "description": "This object represents a firewall rule which blocks specific IP addresses", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "type": { "description": "The type of the rule either 1 = allow or 0 = deny", "type": "integer" }, "ip": { "description": "The target IP address", "type": "string" }, "expire": { "description": "The expire date", "type": "string", "format": "date-time" }, "metadata": { "$ref": "#/components/schemas/Common_Metadata" } } }, "Backend_FirewallCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Firewall" } } } }, "Backend_FirewallCreate": { "$ref": "#/components/schemas/Backend_Firewall" }, "Backend_FirewallUpdate": { "$ref": "#/components/schemas/Backend_Firewall" }, "Backend_Form": { "description": "This object represents a form which helps to dynamically generate a form at a frontend app", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "status": { "description": "Status of the object either 1 = active or 0 = deleted", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "operationId": { "description": "Target operation which gets invoked through this form", "type": "integer" }, "uiSchema": {}, "metadata": { "$ref": "#/components/schemas/Common_Metadata" } } }, "Backend_FormCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Form" } } } }, "Backend_FormCreate": { "$ref": "#/components/schemas/Backend_Form" }, "Backend_FormUpdate": { "$ref": "#/components/schemas/Backend_Form" }, "Backend_GeneratorIndexProvider": { "description": "Represents a concrete generator class", "type": "object", "properties": { "name": { "description": "Human-readable name of the generator class", "type": "string" }, "class": { "description": "Technical identifier of the generator class", "type": "string" } } }, "Backend_GeneratorIndexProviders": { "description": "Contains all possible classes which can be used at an generator as class", "type": "object", "properties": { "providers": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_GeneratorIndexProvider" } } } }, "Backend_GeneratorProvider": { "type": "object", "properties": { "path": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "public": { "type": "boolean" }, "config": { "$ref": "#/components/schemas/Backend_GeneratorProviderConfig" } } }, "Backend_GeneratorProviderChangelog": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Schema" } }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Action" } }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Operation" } } } }, "Backend_GeneratorProviderConfig": { "type": "object", "additionalProperties": {} }, "Backend_HttpRequest": { "description": "This object represents a HTTP request", "type": "object", "properties": { "method": { "description": "HTTP method i.e. GET, POST", "type": "string" }, "uri": { "description": "HTTP request uri", "type": "string" }, "headers": { "description": "HTTP request headers", "type": "object", "additionalProperties": { "type": "string" } }, "body": { "description": "HTTP request body", "type": "string" } } }, "Backend_HttpResponse": { "description": "This object represents a HTTP response", "type": "object", "properties": { "statusCode": { "description": "HTTP status code", "type": "integer" }, "headers": { "description": "HTTP response headers", "type": "object", "additionalProperties": { "type": "string" } }, "body": { "description": "HTTP response body", "type": "string" } } }, "Backend_Identity": { "description": "This object represents an identity which allows to authenticate with a remote identity provider", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "appId": { "description": "The target app for this identity", "type": "integer" }, "roleId": { "description": "Role which is assigned to new users", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "icon": { "description": "An icon for this identity provider", "type": "string" }, "class": { "description": "Underlying class of this identity provider", "type": "string" }, "config": { "$ref": "#/components/schemas/Backend_IdentityConfig" }, "allowCreate": { "type": "boolean" } } }, "Backend_IdentityCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Identity" } } } }, "Backend_IdentityConfig": { "type": "object", "additionalProperties": {} }, "Backend_IdentityCreate": { "$ref": "#/components/schemas/Backend_Identity" }, "Backend_IdentityIndex": { "description": "Contains all possible classes which can be used at an identity as class", "type": "object", "properties": { "providers": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_IdentityIndexEntry" } } } }, "Backend_IdentityIndexEntry": { "description": "Represents a concrete identity class", "type": "object", "properties": { "name": { "description": "Human-readable name of the identity class", "type": "string" }, "class": { "description": "Technical identifier of the identity class", "type": "string" } } }, "Backend_IdentityUpdate": { "$ref": "#/components/schemas/Backend_Identity" }, "Backend_Log": { "description": "This object represents a log entry. Every HTTP requests to the system generates such a log entry.", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "ip": { "description": "The remote IP which has initiated the request", "type": "string" }, "userAgent": { "description": "The user agent provided by the HTTP user agent header", "type": "string" }, "method": { "description": "The HTTP method i.e. GET or POST", "type": "string" }, "path": { "description": "The target path", "type": "string" }, "header": { "description": "The provided HTTP headers", "type": "string" }, "body": { "description": "The provided HTTP body", "type": "string" }, "date": { "description": "Insert date of this request", "type": "string", "format": "date-time" }, "errors": { "description": "An array of errors which occurred through this request", "type": "array", "items": { "$ref": "#/components/schemas/Backend_LogError" } } } }, "Backend_LogCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Log" } } } }, "Backend_LogError": { "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "logId": { "type": "integer" }, "message": { "type": "string" }, "trace": { "type": "string" }, "file": { "type": "string" }, "line": { "type": "integer" }, "insertDate": { "type": "string", "format": "date-time" } } }, "Backend_LogErrorCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_LogError" } } } }, "Backend_Operation": { "description": "This object represents an operation, an operation invokes an action in case a specific HTTP method and path was requested. It defines also schema information about the request and response payload", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "status": { "description": "Status of the object either 1 = active or 0 = deleted", "type": "integer" }, "active": { "description": "Indicates whether the operation is active", "type": "boolean" }, "public": { "description": "Indicates whether the operation is public, if false a user must provide an Authorization header with an Bearer access token", "type": "boolean" }, "stability": { "description": "Describes the stability of this operation 0 = deprecated, 1 = experimental, 2 = stable and 3 = legacy", "type": "integer" }, "description": { "description": "A short description of this operation, it should explain the operation in a simple and precise way", "type": "string" }, "httpMethod": { "description": "The target HTTP method i.e. GET or POST", "type": "string" }, "httpPath": { "description": "The target HTTP path i.e. /foo or /product/:product_id", "type": "string" }, "httpCode": { "description": "The success HTTP code i.e. 200 or 201", "type": "integer" }, "name": { "description": "Unique name of the object. It is recommended to group your operations into logical units by using a dot i.e. product.getAll and product.insert which has also an effect on the automatically generated SDK", "type": "string" }, "parameters": { "$ref": "#/components/schemas/Backend_OperationParameters" }, "incoming": { "description": "Describes the incoming request payload, this must contain a schema name", "type": "string" }, "outgoing": { "description": "Describes the outgoing response payload, this must contain a schema name", "type": "string" }, "throws": { "$ref": "#/components/schemas/Backend_OperationThrows" }, "action": { "description": "The target action to invoke, this must contain an action name", "type": "string" }, "costs": { "description": "Costs to invoke this operation. A user can only invoke this operation in case he has enough points", "type": "integer" }, "scopes": { "description": "Scopes which are required to invoke this operation", "type": "array", "items": { "type": "string" } }, "metadata": { "$ref": "#/components/schemas/Common_Metadata" } } }, "Backend_OperationCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Operation" } } } }, "Backend_OperationCreate": { "$ref": "#/components/schemas/Backend_Operation" }, "Backend_OperationParameters": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Backend_OperationSchema" } }, "Backend_OperationSchema": { "type": "object", "properties": { "description": { "type": "string" }, "type": { "type": "string" }, "format": { "type": "string" }, "enum": { "type": "string" } } }, "Backend_OperationThrows": { "type": "object", "additionalProperties": { "type": "string" } }, "Backend_OperationUpdate": { "$ref": "#/components/schemas/Backend_Operation" }, "Backend_Page": { "description": "This object represents a page at the developer portal", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "status": { "description": "Status of the object either 1 = visible, 2 = invisible or 0 = deleted", "type": "integer" }, "title": { "description": "Title of the page", "type": "string" }, "slug": { "description": "Slug of the page which gets dynamically generated from the title", "type": "string" }, "content": { "description": "HTML content of this page", "type": "string" }, "metadata": { "$ref": "#/components/schemas/Common_Metadata" } } }, "Backend_PageCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Page" } } } }, "Backend_PageCreate": { "$ref": "#/components/schemas/Backend_Page" }, "Backend_PageUpdate": { "$ref": "#/components/schemas/Backend_Page" }, "Backend_Plan": { "description": "This object represents a plan, a plan allows users to obtain points or in general subscribe to your app", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "name": { "description": "Name of the plan", "type": "string" }, "description": { "description": "Short description of the plan", "type": "string" }, "price": { "description": "The price of this plan", "type": "number" }, "points": { "description": "The points which are assigned to the user on purchase", "type": "integer" }, "period": { "description": "Whether the plan is one-time or periodically", "type": "integer" }, "externalId": { "description": "An external id of a remote payment provider like Stripe", "type": "string" }, "scopes": { "description": "Scopes which are assigned dynamically to the user on purchase", "type": "array", "items": { "type": "string" } }, "metadata": { "$ref": "#/components/schemas/Common_Metadata" } } }, "Backend_PlanCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Plan" } } } }, "Backend_PlanCreate": { "$ref": "#/components/schemas/Backend_Plan" }, "Backend_PlanUpdate": { "$ref": "#/components/schemas/Backend_Plan" }, "Backend_Rate": { "description": "This object represents a rate limitation, which allows to limit the requests which a user can send", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "priority": { "description": "All rates are applied based on the priority, higher priorities are applied first", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "rateLimit": { "description": "Maximum number of allowed requests", "type": "integer" }, "timespan": { "description": "Timespan for the allowed requests", "type": "string" }, "allocation": { "description": "Through a rate allocation a user gets assigned to a specific rate", "type": "array", "items": { "$ref": "#/components/schemas/Backend_RateAllocation" } }, "metadata": { "$ref": "#/components/schemas/Common_Metadata" } } }, "Backend_RateAllocation": { "description": "This object represents a rate allocation, in case a request matches it gets assigned to the attached rate", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "operationId": { "type": "integer" }, "userId": { "type": "integer" }, "planId": { "type": "integer" }, "appId": { "type": "integer" }, "authenticated": { "description": "Whether the request is authenticated", "type": "boolean" } } }, "Backend_RateCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Rate" } } } }, "Backend_RateCreate": { "$ref": "#/components/schemas/Backend_Rate" }, "Backend_RateUpdate": { "$ref": "#/components/schemas/Backend_Rate" }, "Backend_Role": { "description": "This object represents a role, every user is assigned to a role and all scopes of the role are automatically attached to the user", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "categoryId": { "description": "The assigned category id of this role", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "scopes": { "description": "All scopes which are assigned to this role", "type": "array", "items": { "type": "string" } } } }, "Backend_RoleCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Role" } } } }, "Backend_RoleCreate": { "$ref": "#/components/schemas/Backend_Role" }, "Backend_RoleUpdate": { "$ref": "#/components/schemas/Backend_Role" }, "Backend_Schema": { "description": "This object represents a schema to describe a JSON payload", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "status": { "description": "Status of the object either 1 = active or 0 = deleted", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "source": { "$ref": "#/components/schemas/Backend_SchemaSource" }, "metadata": { "$ref": "#/components/schemas/Common_Metadata" } } }, "Backend_SchemaCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Schema" } } } }, "Backend_SchemaCommit": { "description": "A schema commit which represents a change in the schema source", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "user": { "$ref": "#/components/schemas/Backend_User" }, "commitHash": { "description": "A unique hash which represents this commit", "type": "string" }, "schema": { "$ref": "#/components/schemas/Backend_SchemaSource" }, "insertDate": { "type": "string", "format": "date-time" } } }, "Backend_SchemaCommitCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_SchemaCommit" } } } }, "Backend_SchemaCreate": { "$ref": "#/components/schemas/Backend_Schema" }, "Backend_SchemaPreviewResponse": { "type": "object", "properties": { "preview": { "type": "string" } } }, "Backend_SchemaSource": { "description": "Contains the TypeSchema specification", "type": "object", "additionalProperties": {} }, "Backend_SchemaUpdate": { "$ref": "#/components/schemas/Backend_Schema" }, "Backend_Scope": { "description": "This object represents a scope. A scope is assigned to a user and is required to access operations", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "description": { "description": "Short description of the scope", "type": "string" }, "operations": { "description": "All operations which can be access through this scope", "type": "array", "items": { "$ref": "#/components/schemas/Backend_ScopeOperation" } }, "metadata": { "$ref": "#/components/schemas/Common_Metadata" } } }, "Backend_ScopeCategories": { "type": "object", "properties": { "categories": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_ScopeCategory" } } } }, "Backend_ScopeCategory": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_ScopeCategoryScope" } } } }, "Backend_ScopeCategoryScope": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "Backend_ScopeCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Scope" } } } }, "Backend_ScopeCreate": { "$ref": "#/components/schemas/Backend_Scope" }, "Backend_ScopeOperation": { "type": "object", "properties": { "operationId": { "type": "integer" }, "allow": { "type": "boolean" } } }, "Backend_ScopeUpdate": { "$ref": "#/components/schemas/Backend_Scope" }, "Backend_SdkGenerate": { "type": "object", "properties": { "format": { "type": "string" }, "config": { "type": "string" } } }, "Backend_SdkMessage": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "link": { "type": "string" } } }, "Backend_SdkResponse": { "type": "object", "properties": { "types": { "$ref": "#/components/schemas/Backend_SdkTypes" } } }, "Backend_SdkTypes": { "description": "Represents available SDK type which can be generated", "type": "object", "additionalProperties": { "type": "string" } }, "Backend_SpecificationChangelog": { "type": "object", "properties": { "master": {}, "tag": {}, "version": { "type": "string" }, "changelog": { "type": "string" } } }, "Backend_SpecificationGet": { "type": "object", "properties": { "spec": {} } }, "Backend_SpecificationPublish": { "type": "object", "properties": { "name": { "type": "string" }, "filterName": { "type": "string" }, "standalone": { "type": "boolean" } } }, "Backend_StatisticChart": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } }, "series": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_StatisticChartSeries" } } } }, "Backend_StatisticChartSeries": { "type": "object", "properties": { "name": { "type": "string" }, "data": { "type": "array", "items": { "type": "number" } } } }, "Backend_StatisticCount": { "type": "object", "properties": { "count": { "type": "integer" }, "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" } } }, "Backend_Taxonomy": { "description": "This object represents a taxonomy. A taxonomy helps to internally organize operations, actions and other entities", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "parentId": { "description": "Identifier of the parent object", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" } } }, "Backend_TaxonomyCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Taxonomy" } } } }, "Backend_TaxonomyCreate": { "$ref": "#/components/schemas/Backend_Taxonomy" }, "Backend_TaxonomyMove": { "description": "Moves the provided objects to a taxonomy", "type": "object", "properties": { "operations": { "type": "array", "items": { "type": "integer" } }, "actions": { "type": "array", "items": { "type": "integer" } }, "schemas": { "type": "array", "items": { "type": "integer" } }, "events": { "type": "array", "items": { "type": "integer" } }, "cronjobs": { "type": "array", "items": { "type": "integer" } }, "triggers": { "type": "array", "items": { "type": "integer" } } } }, "Backend_TaxonomyUpdate": { "$ref": "#/components/schemas/Backend_Taxonomy" }, "Backend_Test": { "description": "This object represents a test. A test helps to verify that all operations work as expected", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "status": { "description": "Status of the object either 1 = pending, 2 = success, 3 = warning, 4 = error, 5 = skipped or 6 = disabled", "type": "integer" }, "operationName": { "type": "string" }, "message": { "type": "string" }, "response": { "type": "string" }, "config": { "$ref": "#/components/schemas/Backend_TestConfig" } } }, "Backend_TestCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Test" } } } }, "Backend_TestConfig": { "$ref": "#/components/schemas/Backend_ActionExecuteRequest" }, "Backend_Token": { "description": "This object represents a token, this an access token which was requested by a user", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "status": { "description": "Status of the object either 1 = active or 2 = deleted", "type": "integer" }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "ip": { "type": "string" }, "expire": { "type": "string", "format": "date-time" }, "date": { "type": "string", "format": "date-time" } } }, "Backend_TokenCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Token" } } } }, "Backend_Transaction": { "description": "This object represents a transaction. The system generates a transaction in case a payment was successfully executed", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "userId": { "type": "integer" }, "planId": { "type": "integer" }, "transactionId": { "type": "string" }, "amount": { "type": "number" }, "points": { "type": "number" }, "periodStart": { "type": "string", "format": "date-time" }, "periodEnd": { "type": "string", "format": "date-time" }, "insertDate": { "type": "string", "format": "date-time" } } }, "Backend_TransactionCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Transaction" } } } }, "Backend_TrashData": { "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "status": { "description": "Status of the object either 1 = active or 0 = deleted", "type": "integer" }, "name": { "type": "string" } } }, "Backend_TrashDataCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_TrashData" } } } }, "Backend_TrashRestore": { "type": "object", "properties": { "id": { "type": "integer" } } }, "Backend_TrashTypes": { "type": "object", "properties": { "types": { "type": "array", "items": { "type": "string" } } } }, "Backend_Trigger": { "description": "This object represents a trigger which can invoke an action on a custom event", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "event": { "description": "The name of the trigger event", "type": "string" }, "action": { "description": "The target action which gets invoked", "type": "string" }, "metadata": { "$ref": "#/components/schemas/Common_Metadata" } } }, "Backend_TriggerCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Trigger" } } } }, "Backend_TriggerCreate": { "$ref": "#/components/schemas/Backend_Trigger" }, "Backend_TriggerUpdate": { "$ref": "#/components/schemas/Backend_Trigger" }, "Backend_User": { "description": "This object represents a user", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "roleId": { "description": "A role which is assigned to the user", "type": "integer" }, "planId": { "description": "A plan which is assigned to the user", "type": "integer" }, "status": { "description": "Status of the object either 1 = active, 2 = disabled or 0 = deleted", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "email": { "description": "The email address of the user", "type": "string" }, "points": { "description": "Points assigned to the user", "type": "integer" }, "scopes": { "description": "List of scopes which are assigned to the user", "type": "array", "items": { "type": "string" } }, "apps": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_App" } }, "metadata": { "$ref": "#/components/schemas/Common_Metadata" }, "date": { "description": "The insert date", "type": "string", "format": "date-time" } } }, "Backend_UserCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_User" } } } }, "Backend_UserCreate": { "allOf": [ { "$ref": "#/components/schemas/Backend_User" }, { "type": "object", "properties": { "password": { "type": "string" } } } ] }, "Backend_UserUpdate": { "$ref": "#/components/schemas/Backend_User" }, "Backend_Webhook": { "description": "This object represents a webhook, a webhook is called in case a specific event was triggered", "type": "object", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "eventId": { "type": "integer" }, "userId": { "type": "integer" }, "name": { "type": "string" }, "endpoint": { "type": "string" }, "responses": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_WebhookResponse" } } } }, "Backend_WebhookCollection": { "description": "Base collection", "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Backend_Webhook" } } } }, "Backend_WebhookCreate": { "$ref": "#/components/schemas/Backend_Webhook" }, "Backend_WebhookResponse": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "integer" }, "code": { "type": "integer" }, "attempts": { "type": "integer" }, "error": { "type": "string" }, "executeDate": { "type": "string", "format": "date-time" } } }, "Backend_WebhookUpdate": { "$ref": "#/components/schemas/Backend_Webhook" }, "Common_FormContainer": { "description": "Represents a config form with a list of elements", "type": "object", "properties": { "element": { "type": "array", "items": { "$ref": "#/components/schemas/Common_FormElement" } } } }, "Common_FormElement": { "oneOf": [ { "$ref": "#/components/schemas/Common_FormElementCheckbox" }, { "$ref": "#/components/schemas/Common_FormElementCollection" }, { "$ref": "#/components/schemas/Common_FormElementInput" }, { "$ref": "#/components/schemas/Common_FormElementMap" }, { "$ref": "#/components/schemas/Common_FormElementSelect" }, { "$ref": "#/components/schemas/Common_FormElementTextArea" }, { "$ref": "#/components/schemas/Common_FormElementTypeAPI" }, { "$ref": "#/components/schemas/Common_FormElementTypeSchema" } ], "discriminator": "type", "mapping": { "checkbox": "#/components/schemas/Common_FormElementCheckbox", "collection": "#/components/schemas/Common_FormElementCollection", "input": "#/components/schemas/Common_FormElementInput", "map": "#/components/schemas/Common_FormElementMap", "select": "#/components/schemas/Common_FormElementSelect", "textarea": "#/components/schemas/Common_FormElementTextArea", "typeapi": "#/components/schemas/Common_FormElementTypeAPI", "typeschema": "#/components/schemas/Common_FormElementTypeSchema" } }, "Common_FormElementCheckbox": { "$ref": "#/components/schemas/Common_FormElement" }, "Common_FormElementCollection": { "allOf": [ { "$ref": "#/components/schemas/Common_FormElement" }, { "description": "Form element which represents a collection element", "type": "object", "properties": { "type": { "description": "The input type i.e. text or password, all HTML input types are allowed", "type": "string" } } } ] }, "Common_FormElementInput": { "allOf": [ { "$ref": "#/components/schemas/Common_FormElement" }, { "description": "Form element which represents an input element", "type": "object", "properties": { "type": { "description": "The input type i.e. text or password, all HTML input types are allowed", "type": "string" } } } ] }, "Common_FormElementMap": { "allOf": [ { "$ref": "#/components/schemas/Common_FormElement" }, { "description": "Form element which represents a map element", "type": "object", "properties": { "type": { "description": "The input type i.e. text or password, all HTML input types are allowed", "type": "string" } } } ] }, "Common_FormElementSelect": { "allOf": [ { "$ref": "#/components/schemas/Common_FormElement" }, { "description": "Form element which represents a select element", "type": "object", "properties": { "options": { "description": "Available options for the select element", "type": "array", "items": { "$ref": "#/components/schemas/Common_FormElementSelectOption" } } } } ] }, "Common_FormElementSelectOption": { "description": "Represents a concrete option entry", "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "Common_FormElementTextArea": { "allOf": [ { "$ref": "#/components/schemas/Common_FormElement" }, { "description": "Form element which represents a textarea", "type": "object", "properties": { "mode": { "description": "Describes which data is provided at the textarea, this can be i.e. a programming language like php, java or python or also a data format like json", "type": "string" } } } ] }, "Common_FormElementTypeAPI": { "$ref": "#/components/schemas/Common_FormElement" }, "Common_FormElementTypeSchema": { "$ref": "#/components/schemas/Common_FormElement" }, "Common_Message": { "description": "Common error message", "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "id": { "type": "string" } } }, "Common_Metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "MarketplaceAction": { "allOf": [ { "$ref": "#/components/schemas/MarketplaceObject" }, { "type": "object", "properties": { "class": { "type": "string" }, "config": { "$ref": "#/components/schemas/MarketplaceActionConfig" } } } ] }, "MarketplaceActionCollection": { "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceAction" } } } }, "MarketplaceActionConfig": { "type": "object", "additionalProperties": {} }, "MarketplaceApp": { "allOf": [ { "$ref": "#/components/schemas/MarketplaceObject" }, { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "downloadUrl": { "type": "string" }, "hash": { "type": "string" } } } ] }, "MarketplaceAppCollection": { "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceApp" } } } }, "MarketplaceBundle": { "allOf": [ { "$ref": "#/components/schemas/MarketplaceObject" }, { "type": "object", "properties": { "config": { "$ref": "#/components/schemas/MarketplaceBundleConfig" } } } ] }, "MarketplaceBundleAction": { "type": "object", "properties": { "name": { "type": "string" }, "class": { "type": "string" }, "config": { "$ref": "#/components/schemas/MarketplaceBundleActionConfig" } } }, "MarketplaceBundleActionConfig": { "type": "object", "additionalProperties": {} }, "MarketplaceBundleCollection": { "type": "object", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceBundle" } } } }, "MarketplaceBundleConfig": { "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceBundleAction" } }, "schemas": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceBundleSchema" } }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceBundleEvent" } }, "cronjobs": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceBundleCronjob" } }, "triggers": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceBundleTrigger" } } } }, "MarketplaceBundleCronjob": { "type": "object", "properties": { "name": { "type": "string" }, "cron": { "type": "string" }, "action": { "type": "string" } } }, "MarketplaceBundleEvent": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "schema": { "type": "string" } } }, "MarketplaceBundleSchema": { "type": "object", "properties": { "name": { "type": "string" }, "source": { "$ref": "#/components/schemas/MarketplaceBundleSchemaSource" } } }, "MarketplaceBundleSchemaSource": { "type": "object", "additionalProperties": {} }, "MarketplaceBundleTrigger": { "type": "object", "properties": { "name": { "type": "string" }, "event": { "type": "string" }, "action": { "type": "string" } } }, "MarketplaceInstall": { "description": "Installs an object from the marketplace", "type": "object", "properties": { "name": { "type": "string" } } }, "MarketplaceMessage": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "id": { "type": "string" } } }, "MarketplaceObject": { "description": "Base class of all objects on the marketplace", "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "author": { "$ref": "#/components/schemas/MarketplaceUser" }, "version": { "type": "string" }, "icon": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "cost": { "type": "integer" }, "updateDate": { "type": "string", "format": "date-time" }, "insertDate": { "type": "string", "format": "date-time" } } }, "MarketplaceUser": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "verified": { "type": "boolean" } } }, "Passthru": { "description": "No schema information available", "type": "object", "additionalProperties": {} } }, "securitySchemes": { "app": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://demo.fusio-project.org/authorization/token", "refreshUrl": "https://demo.fusio-project.org/authorization/token", "scopes": { "backend": "", "backend.account": "", "backend.action": "", "backend.agent": "", "backend.app": "", "backend.audit": "", "backend.backup": "", "backend.bundle": "", "backend.category": "", "backend.config": "", "backend.connection": "", "backend.cronjob": "", "backend.dashboard": "", "backend.event": "", "backend.firewall": "", "backend.form": "", "backend.generator": "", "backend.identity": "", "backend.log": "", "backend.marketplace": "", "backend.operation": "", "backend.page": "", "backend.plan": "", "backend.rate": "", "backend.role": "", "backend.schema": "", "backend.scope": "", "backend.sdk": "", "backend.specification": "", "backend.statistic": "", "backend.taxonomy": "", "backend.tenant": "", "backend.test": "", "backend.token": "", "backend.transaction": "", "backend.trash": "", "backend.trigger": "", "backend.user": "", "backend.webhook": "" } }, "authorizationCode": { "authorizationUrl": "https://demo.fusio-project.org/authorization/authorize", "tokenUrl": "https://demo.fusio-project.org/authorization/token", "refreshUrl": "https://demo.fusio-project.org/authorization/token", "scopes": { "backend": "", "backend.account": "", "backend.action": "", "backend.agent": "", "backend.app": "", "backend.audit": "", "backend.backup": "", "backend.bundle": "", "backend.category": "", "backend.config": "", "backend.connection": "", "backend.cronjob": "", "backend.dashboard": "", "backend.event": "", "backend.firewall": "", "backend.form": "", "backend.generator": "", "backend.identity": "", "backend.log": "", "backend.marketplace": "", "backend.operation": "", "backend.page": "", "backend.plan": "", "backend.rate": "", "backend.role": "", "backend.schema": "", "backend.scope": "", "backend.sdk": "", "backend.specification": "", "backend.statistic": "", "backend.taxonomy": "", "backend.tenant": "", "backend.test": "", "backend.token": "", "backend.transaction": "", "backend.trash": "", "backend.trigger": "", "backend.user": "", "backend.webhook": "" } } } } } } }