openapi.json

{
  "openapi": "3.0.0",
  "info": {
    "title": "dstack KMS Mock Backend API",
    "description": "Mock API for dstack KMS backend - all authentications will succeed (no blockchain interaction)",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "http://localhost:3000",
      "description": "Development server"
    }
  ],
  "paths": {
    "/": {
      "get": {
        "summary": "Health check and system information",
        "description": "Returns mock system status and configuration information",
        "operationId": "getSystemInfo",
        "responses": {
          "200": {
            "description": "Mock system information",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MockSystemInfo"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/bootAuth/app": {
      "post": {
        "summary": "Application boot authentication (mock - always succeeds)",
        "description": "Mock validation that always allows application boot",
        "operationId": "authenticateAppBoot",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BootInfo"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Authentication result (always success in mock)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BootResponse"
                }
              }
            }
          }
        }
      }
    },
    "/bootAuth/kms": {
      "post": {
        "summary": "KMS boot authentication (mock - always succeeds)",
        "description": "Mock validation that always allows KMS boot",
        "operationId": "authenticateKmsBoot",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BootInfo"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Authentication result (always success in mock)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BootResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "BootInfo": {
        "type": "object",
        "required": [
          "mrAggregated",
          "osImageHash", 
          "appId",
          "composeHash",
          "instanceId",
          "deviceId"
        ],
        "properties": {
          "mrAggregated": {
            "type": "string",
            "description": "Aggregated MR measurement"
          },
          "osImageHash": {
            "type": "string", 
            "description": "OS Image hash"
          },
          "appId": {
            "type": "string",
            "description": "Application ID"
          },
          "composeHash": {
            "type": "string",
            "description": "Compose hash"
          },
          "instanceId": {
            "type": "string",
            "description": "Instance ID"
          },
          "deviceId": {
            "type": "string",
            "description": "Device ID"
          },
          "tcbStatus": {
            "type": "string",
            "description": "TCB status (optional for compatibility)"
          },
          "advisoryIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Advisory IDs (optional for compatibility)"
          },
          "mrSystem": {
            "type": "string",
            "description": "MR System measurement (optional for compatibility)"
          }
        }
      },
      "BootResponse": {
        "type": "object",
        "required": [
          "isAllowed",
          "reason", 
          "gatewayAppId"
        ],
        "properties": {
          "isAllowed": {
            "type": "boolean",
            "description": "Whether the boot is allowed (always true in mock)",
            "example": true
          },
          "reason": {
            "type": "string",
            "description": "Reason for the decision",
            "example": "mock app always allowed"
          },
          "gatewayAppId": {
            "type": "string",
            "description": "Mock gateway application ID",
            "example": "0xmockgateway1234567890123456789012345678"
          }
        }
      },
      "MockSystemInfo": {
        "type": "object",
        "required": [
          "status",
          "kmsContractAddr",
          "gatewayAppId",
          "chainId",
          "appAuthImplementation",
          "appImplementation",
          "note"
        ],
        "properties": {
          "status": {
            "type": "string",
            "enum": ["ok"],
            "description": "System status"
          },
          "kmsContractAddr": {
            "type": "string",
            "description": "Mock KMS contract address",
            "example": "0xmockcontract1234567890123456789012345678"
          },
          "gatewayAppId": {
            "type": "string", 
            "description": "Mock gateway application ID",
            "example": "0xmockgateway1234567890123456789012345678"
          },
          "chainId": {
            "type": "number",
            "description": "Mock blockchain chain ID",
            "example": 1337
          },
          "appAuthImplementation": {
            "type": "string",
            "description": "Mock app auth implementation address (deprecated, use appImplementation)",
            "example": "0xmockapp9876543210987654321098765432109"
          },
          "appImplementation": {
            "type": "string",
            "description": "Mock app implementation address",
            "example": "0xmockapp9876543210987654321098765432109"
          },
          "note": {
            "type": "string",
            "description": "Note about mock backend behavior",
            "example": "this is a mock backend - all authentications will succeed"
          }
        }
      },
      "Error": {
        "type": "object",
        "required": [
          "status",
          "message"
        ],
        "properties": {
          "status": {
            "type": "string",
            "enum": ["error"]
          },
          "message": {
            "type": "string",
            "description": "Error message"
          }
        }
      }
    }
  }
}