Mathis/llamactl
1
0
Fork 0
mirror of https://github.com/lordmathis/llamactl.git synced 2025-12-22 17:14:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update swagger api docs

Browse Source
This commit is contained in:
Matúš Námešný
2025-11-14 23:43:14 +01:00
parent 4f8f4b96cd
commit 6ed99fccf9
3 changed files with 122 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
docs/docs.go
View File

@@ -1512,16 +1512,16 @@ const docTemplate = `{
"backends": { "backends": {
"$ref": "#/definitions/config.BackendConfig" "$ref": "#/definitions/config.BackendConfig"
}, },
"buildTime": { "build_time": {
"type": "string" "type": "string"
}, },
"commitHash": { "commit_hash": {
"type": "string" "type": "string"
}, },
"instances": { "instances": {
"$ref": "#/definitions/config.InstancesConfig" "$ref": "#/definitions/config.InstancesConfig"
}, },
"localNode": { "local_node": {
"type": "string" "type": "string"
}, },
"nodes": { "nodes": {
@@ -1541,25 +1541,25 @@ const docTemplate = `{
"config.AuthConfig": { "config.AuthConfig": {
"type": "object", "type": "object",
"properties": { "properties": {
"inferenceKeys": { "inference_keys": {
"description": "List of keys for OpenAI compatible inference endpoints", "description": "List of keys for OpenAI compatible inference endpoints",
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
} }
}, },
"managementKeys": { "management_keys": {
"description": "List of keys for management endpoints", "description": "List of keys for management endpoints",
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
} }
}, },
"requireInferenceAuth": { "require_inference_auth": {
"description": "Require authentication for OpenAI compatible inference endpoints", "description": "Require authentication for OpenAI compatible inference endpoints",
"type": "boolean" "type": "boolean"
}, },
"requireManagementAuth": { "require_management_auth": {
"description": "Require authentication for management endpoints", "description": "Require authentication for management endpoints",
"type": "boolean" "type": "boolean"
} }
@@ -1568,7 +1568,7 @@ const docTemplate = `{
"config.BackendConfig": { "config.BackendConfig": {
"type": "object", "type": "object",
"properties": { "properties": {
"llamaCpp": { "llama-cpp": {
"$ref": "#/definitions/config.BackendSettings" "$ref": "#/definitions/config.BackendSettings"
}, },
"mlx": { "mlx": {
@@ -1600,7 +1600,7 @@ const docTemplate = `{
"type": "string" "type": "string"
} }
}, },
"responseHeaders": { "response_headers": {
"type": "object", "type": "object",
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
@@ -1634,62 +1634,62 @@ const docTemplate = `{
"config.InstancesConfig": { "config.InstancesConfig": {
"type": "object", "type": "object",
"properties": { "properties": {
"autoCreateDirs": { "auto_create_dirs": {
"description": "Automatically create the data directory if it doesn't exist", "description": "Automatically create the data directory if it doesn't exist",
"type": "boolean" "type": "boolean"
}, },
"dataDir": { "configs_dir": {
"description": "Directory where all llamactl data will be stored (instances.json, logs, etc.)",
"type": "string"
},
"defaultAutoRestart": {
"description": "Default auto-restart setting for new instances",
"type": "boolean"
},
"defaultMaxRestarts": {
"description": "Default max restarts for new instances",
"type": "integer"
},
"defaultOnDemandStart": {
"description": "Default on-demand start setting for new instances",
"type": "boolean"
},
"defaultRestartDelay": {
"description": "Default restart delay for new instances (in seconds)",
"type": "integer"
},
"enableLRUEviction": {
"description": "Enable LRU eviction for instance logs",
"type": "boolean"
},
"instancesDir": {
"description": "Instance config directory override", "description": "Instance config directory override",
"type": "string" "type": "string"
}, },
"logsDir": { "data_dir": {
"description": "Directory where all llamactl data will be stored (instances.json, logs, etc.)",
"type": "string"
},
"default_auto_restart": {
"description": "Default auto-restart setting for new instances",
"type": "boolean"
},
"default_max_restarts": {
"description": "Default max restarts for new instances",
"type": "integer"
},
"default_on_demand_start": {
"description": "Default on-demand start setting for new instances",
"type": "boolean"
},
"default_restart_delay": {
"description": "Default restart delay for new instances (in seconds)",
"type": "integer"
},
"enable_lru_eviction": {
"description": "Enable LRU eviction for instance logs",
"type": "boolean"
},
"logs_dir": {
"description": "Logs directory override", "description": "Logs directory override",
"type": "string" "type": "string"
}, },
"maxInstances": { "max_instances": {
"description": "Maximum number of instances that can be created", "description": "Maximum number of instances that can be created",
"type": "integer" "type": "integer"
}, },
"maxRunningInstances": { "max_running_instances": {
"description": "Maximum number of instances that can be running at the same time", "description": "Maximum number of instances that can be running at the same time",
"type": "integer" "type": "integer"
}, },
"onDemandStartTimeout": { "on_demand_start_timeout": {
"description": "How long to wait for an instance to start on demand (in seconds)", "description": "How long to wait for an instance to start on demand (in seconds)",
"type": "integer" "type": "integer"
}, },
"portRange": { "port_range": {
"description": "Port range for instances (e.g., 8000,9000)", "description": "Port range for instances (e.g., 8000,9000)",
"type": "array", "type": "array",
"items": { "items": {
"type": "integer" "type": "integer"
} }
}, },
"timeoutCheckInterval": { "timeout_check_interval": {
"description": "Interval for checking instance timeouts (in minutes)", "description": "Interval for checking instance timeouts (in minutes)",
"type": "integer" "type": "integer"
} }
@@ -1701,7 +1701,7 @@ const docTemplate = `{
"address": { "address": {
"type": "string" "type": "string"
}, },
"apikey": { "api_key": {
"type": "string" "type": "string"
} }
} }
@@ -1709,21 +1709,21 @@ const docTemplate = `{
"config.ServerConfig": { "config.ServerConfig": {
"type": "object", "type": "object",
"properties": { "properties": {
"allowedHeaders": { "allowed_headers": {
"description": "Allowed headers for CORS (e.g., \"Accept\", \"Authorization\", \"Content-Type\", \"X-CSRF-Token\")", "description": "Allowed headers for CORS (e.g., \"Accept\", \"Authorization\", \"Content-Type\", \"X-CSRF-Token\")",
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
} }
}, },
"allowedOrigins": { "allowed_origins": {
"description": "Allowed origins for CORS (e.g., \"http://localhost:3000\")", "description": "Allowed origins for CORS (e.g., \"http://localhost:3000\")",
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
} }
}, },
"enableSwagger": { "enable_swagger": {
"description": "Enable Swagger UI for API documentation", "description": "Enable Swagger UI for API documentation",
"type": "boolean" "type": "boolean"
}, },
@@ -1735,7 +1735,7 @@ const docTemplate = `{
"description": "Server port to bind to", "description": "Server port to bind to",
"type": "integer" "type": "integer"
}, },
"responseHeaders": { "response_headers": {
"description": "Response headers to send with responses", "description": "Response headers to send with responses",
"type": "object", "type": "object",
"additionalProperties": { "additionalProperties": {

92
docs/swagger.json
View File

@@ -1505,16 +1505,16 @@
"backends": { "backends": {
"$ref": "#/definitions/config.BackendConfig" "$ref": "#/definitions/config.BackendConfig"
}, },
"buildTime": { "build_time": {
"type": "string" "type": "string"
}, },
"commitHash": { "commit_hash": {
"type": "string" "type": "string"
}, },
"instances": { "instances": {
"$ref": "#/definitions/config.InstancesConfig" "$ref": "#/definitions/config.InstancesConfig"
}, },
"localNode": { "local_node": {
"type": "string" "type": "string"
}, },
"nodes": { "nodes": {
@@ -1534,25 +1534,25 @@
"config.AuthConfig": { "config.AuthConfig": {
"type": "object", "type": "object",
"properties": { "properties": {
"inferenceKeys": { "inference_keys": {
"description": "List of keys for OpenAI compatible inference endpoints", "description": "List of keys for OpenAI compatible inference endpoints",
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
} }
}, },
"managementKeys": { "management_keys": {
"description": "List of keys for management endpoints", "description": "List of keys for management endpoints",
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
} }
}, },
"requireInferenceAuth": { "require_inference_auth": {
"description": "Require authentication for OpenAI compatible inference endpoints", "description": "Require authentication for OpenAI compatible inference endpoints",
"type": "boolean" "type": "boolean"
}, },
"requireManagementAuth": { "require_management_auth": {
"description": "Require authentication for management endpoints", "description": "Require authentication for management endpoints",
"type": "boolean" "type": "boolean"
} }
@@ -1561,7 +1561,7 @@
"config.BackendConfig": { "config.BackendConfig": {
"type": "object", "type": "object",
"properties": { "properties": {
"llamaCpp": { "llama-cpp": {
"$ref": "#/definitions/config.BackendSettings" "$ref": "#/definitions/config.BackendSettings"
}, },
"mlx": { "mlx": {
@@ -1593,7 +1593,7 @@
"type": "string" "type": "string"
} }
}, },
"responseHeaders": { "response_headers": {
"type": "object", "type": "object",
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
@@ -1627,62 +1627,62 @@
"config.InstancesConfig": { "config.InstancesConfig": {
"type": "object", "type": "object",
"properties": { "properties": {
"autoCreateDirs": { "auto_create_dirs": {
"description": "Automatically create the data directory if it doesn't exist", "description": "Automatically create the data directory if it doesn't exist",
"type": "boolean" "type": "boolean"
}, },
"dataDir": { "configs_dir": {
"description": "Directory where all llamactl data will be stored (instances.json, logs, etc.)",
"type": "string"
},
"defaultAutoRestart": {
"description": "Default auto-restart setting for new instances",
"type": "boolean"
},
"defaultMaxRestarts": {
"description": "Default max restarts for new instances",
"type": "integer"
},
"defaultOnDemandStart": {
"description": "Default on-demand start setting for new instances",
"type": "boolean"
},
"defaultRestartDelay": {
"description": "Default restart delay for new instances (in seconds)",
"type": "integer"
},
"enableLRUEviction": {
"description": "Enable LRU eviction for instance logs",
"type": "boolean"
},
"instancesDir": {
"description": "Instance config directory override", "description": "Instance config directory override",
"type": "string" "type": "string"
}, },
"logsDir": { "data_dir": {
"description": "Directory where all llamactl data will be stored (instances.json, logs, etc.)",
"type": "string"
},
"default_auto_restart": {
"description": "Default auto-restart setting for new instances",
"type": "boolean"
},
"default_max_restarts": {
"description": "Default max restarts for new instances",
"type": "integer"
},
"default_on_demand_start": {
"description": "Default on-demand start setting for new instances",
"type": "boolean"
},
"default_restart_delay": {
"description": "Default restart delay for new instances (in seconds)",
"type": "integer"
},
"enable_lru_eviction": {
"description": "Enable LRU eviction for instance logs",
"type": "boolean"
},
"logs_dir": {
"description": "Logs directory override", "description": "Logs directory override",
"type": "string" "type": "string"
}, },
"maxInstances": { "max_instances": {
"description": "Maximum number of instances that can be created", "description": "Maximum number of instances that can be created",
"type": "integer" "type": "integer"
}, },
"maxRunningInstances": { "max_running_instances": {
"description": "Maximum number of instances that can be running at the same time", "description": "Maximum number of instances that can be running at the same time",
"type": "integer" "type": "integer"
}, },
"onDemandStartTimeout": { "on_demand_start_timeout": {
"description": "How long to wait for an instance to start on demand (in seconds)", "description": "How long to wait for an instance to start on demand (in seconds)",
"type": "integer" "type": "integer"
}, },
"portRange": { "port_range": {
"description": "Port range for instances (e.g., 8000,9000)", "description": "Port range for instances (e.g., 8000,9000)",
"type": "array", "type": "array",
"items": { "items": {
"type": "integer" "type": "integer"
} }
}, },
"timeoutCheckInterval": { "timeout_check_interval": {
"description": "Interval for checking instance timeouts (in minutes)", "description": "Interval for checking instance timeouts (in minutes)",
"type": "integer" "type": "integer"
} }
@@ -1694,7 +1694,7 @@
"address": { "address": {
"type": "string" "type": "string"
}, },
"apikey": { "api_key": {
"type": "string" "type": "string"
} }
} }
@@ -1702,21 +1702,21 @@
"config.ServerConfig": { "config.ServerConfig": {
"type": "object", "type": "object",
"properties": { "properties": {
"allowedHeaders": { "allowed_headers": {
"description": "Allowed headers for CORS (e.g., \"Accept\", \"Authorization\", \"Content-Type\", \"X-CSRF-Token\")", "description": "Allowed headers for CORS (e.g., \"Accept\", \"Authorization\", \"Content-Type\", \"X-CSRF-Token\")",
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
} }
}, },
"allowedOrigins": { "allowed_origins": {
"description": "Allowed origins for CORS (e.g., \"http://localhost:3000\")", "description": "Allowed origins for CORS (e.g., \"http://localhost:3000\")",
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
} }
}, },
"enableSwagger": { "enable_swagger": {
"description": "Enable Swagger UI for API documentation", "description": "Enable Swagger UI for API documentation",
"type": "boolean" "type": "boolean"
}, },
@@ -1728,7 +1728,7 @@
"description": "Server port to bind to", "description": "Server port to bind to",
"type": "integer" "type": "integer"
}, },
"responseHeaders": { "response_headers": {
"description": "Response headers to send with responses", "description": "Response headers to send with responses",
"type": "object", "type": "object",
"additionalProperties": { "additionalProperties": {

60
docs/swagger.yaml
View File

@@ -6,13 +6,13 @@ definitions:
$ref: '#/definitions/config.AuthConfig' $ref: '#/definitions/config.AuthConfig'
backends: backends:
$ref: '#/definitions/config.BackendConfig' $ref: '#/definitions/config.BackendConfig'
buildTime: build_time:
type: string type: string
commitHash: commit_hash:
type: string type: string
instances: instances:
$ref: '#/definitions/config.InstancesConfig' $ref: '#/definitions/config.InstancesConfig'
localNode: local_node:
type: string type: string
nodes: nodes:
additionalProperties: additionalProperties:
@@ -25,26 +25,26 @@ definitions:
type: object type: object
config.AuthConfig: config.AuthConfig:
properties: properties:
inferenceKeys: inference_keys:
description: List of keys for OpenAI compatible inference endpoints description: List of keys for OpenAI compatible inference endpoints
items: items:
type: string type: string
type: array type: array
managementKeys: management_keys:
description: List of keys for management endpoints description: List of keys for management endpoints
items: items:
type: string type: string
type: array type: array
requireInferenceAuth: require_inference_auth:
description: Require authentication for OpenAI compatible inference endpoints description: Require authentication for OpenAI compatible inference endpoints
type: boolean type: boolean
requireManagementAuth: require_management_auth:
description: Require authentication for management endpoints description: Require authentication for management endpoints
type: boolean type: boolean
type: object type: object
config.BackendConfig: config.BackendConfig:
properties: properties:
llamaCpp: llama-cpp:
$ref: '#/definitions/config.BackendSettings' $ref: '#/definitions/config.BackendSettings'
mlx: mlx:
$ref: '#/definitions/config.BackendSettings' $ref: '#/definitions/config.BackendSettings'
@@ -65,7 +65,7 @@ definitions:
additionalProperties: additionalProperties:
type: string type: string
type: object type: object
responseHeaders: response_headers:
additionalProperties: additionalProperties:
type: string type: string
type: object type: object
@@ -87,49 +87,49 @@ definitions:
type: object type: object
config.InstancesConfig: config.InstancesConfig:
properties: properties:
autoCreateDirs: auto_create_dirs:
description: Automatically create the data directory if it doesn't exist description: Automatically create the data directory if it doesn't exist
type: boolean type: boolean
dataDir: configs_dir:
description: Instance config directory override
type: string
data_dir:
description: Directory where all llamactl data will be stored (instances.json, description: Directory where all llamactl data will be stored (instances.json,
logs, etc.) logs, etc.)
type: string type: string
defaultAutoRestart: default_auto_restart:
description: Default auto-restart setting for new instances description: Default auto-restart setting for new instances
type: boolean type: boolean
defaultMaxRestarts: default_max_restarts:
description: Default max restarts for new instances description: Default max restarts for new instances
type: integer type: integer
defaultOnDemandStart: default_on_demand_start:
description: Default on-demand start setting for new instances description: Default on-demand start setting for new instances
type: boolean type: boolean
defaultRestartDelay: default_restart_delay:
description: Default restart delay for new instances (in seconds) description: Default restart delay for new instances (in seconds)
type: integer type: integer
enableLRUEviction: enable_lru_eviction:
description: Enable LRU eviction for instance logs description: Enable LRU eviction for instance logs
type: boolean type: boolean
instancesDir: logs_dir:
description: Instance config directory override
type: string
logsDir:
description: Logs directory override description: Logs directory override
type: string type: string
maxInstances: max_instances:
description: Maximum number of instances that can be created description: Maximum number of instances that can be created
type: integer type: integer
maxRunningInstances: max_running_instances:
description: Maximum number of instances that can be running at the same time description: Maximum number of instances that can be running at the same time
type: integer type: integer
onDemandStartTimeout: on_demand_start_timeout:
description: How long to wait for an instance to start on demand (in seconds) description: How long to wait for an instance to start on demand (in seconds)
type: integer type: integer
portRange: port_range:
description: Port range for instances (e.g., 8000,9000) description: Port range for instances (e.g., 8000,9000)
items: items:
type: integer type: integer
type: array type: array
timeoutCheckInterval: timeout_check_interval:
description: Interval for checking instance timeouts (in minutes) description: Interval for checking instance timeouts (in minutes)
type: integer type: integer
type: object type: object
@@ -137,23 +137,23 @@ definitions:
properties: properties:
address: address:
type: string type: string
apikey: api_key:
type: string type: string
type: object type: object
config.ServerConfig: config.ServerConfig:
properties: properties:
allowedHeaders: allowed_headers:
description: Allowed headers for CORS (e.g., "Accept", "Authorization", "Content-Type", description: Allowed headers for CORS (e.g., "Accept", "Authorization", "Content-Type",
"X-CSRF-Token") "X-CSRF-Token")
items: items:
type: string type: string
type: array type: array
allowedOrigins: allowed_origins:
description: Allowed origins for CORS (e.g., "http://localhost:3000") description: Allowed origins for CORS (e.g., "http://localhost:3000")
items: items:
type: string type: string
type: array type: array
enableSwagger: enable_swagger:
description: Enable Swagger UI for API documentation description: Enable Swagger UI for API documentation
type: boolean type: boolean
host: host:
@@ -162,7 +162,7 @@ definitions:
port: port:
description: Server port to bind to description: Server port to bind to
type: integer type: integer
responseHeaders: response_headers:
additionalProperties: additionalProperties:
type: string type: string
description: Response headers to send with responses description: Response headers to send with responses