swagger.json

{
  "openapi": "3.0.3",
  "info": {
    "title": "StreamDeck API Server - OpenAPI Spec",
    "description": "This is the OpenAPI specification for the StreamDeck API Server. This API server is used to control the Unreal Engine using the StreamDeck plugin.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "http://localhost:2206/api/v1"
    }
  ],
  "paths": {
    "/health": {
      "get": {
        "description": "Returns some basic information about the Unreal Engine",
        "responses": {
          "200": {
            "description": "Default success response",
            "content": {
              "application/json": {
                "example": {
                  "data": {
                    "Engine": {
                      "Version": "4.26.2"
                    },
                    "Memory": {
                      "Available": 68719476736,
                      "Used": 35181692437
                    },
                    "Plugin": {
                      "Name": "MadDevRemote",
                      "Version": "1.0.0",
                      "Author": "Copyright (c) 2024 - Mad Dev Games. All Rights Reserved."
                    }
                  },
                  "code": 200,
                  "message": "OK",
                  "success": true
                }
              }
            }
          }
        }
      }
    },
    "/command": {
      "post": {
        "description": "Runs a command in the Unreal Engine",
        "responses": {
          "200": {
            "description": "Default success response",
            "content": {
              "application/json": {
                "example": {
                  "data": {},
                  "code": 200,
                  "message": "Command executed",
                  "success": true
                }
              }
            }
          }
        }
      }
    }
  }
}