Capitalize godoc tags

This commit is contained in:
2025-10-26 16:49:27 +01:00
parent 6c522a2199
commit 249ff2a7aa
8 changed files with 125 additions and 125 deletions

View File

@@ -44,7 +44,7 @@ func (h *Handler) stripLlamaCppPrefix(r *http.Request, instName string) {
// LlamaCppUIProxy godoc
// @Summary Proxy requests to llama.cpp UI for the instance
// @Description Proxies requests to the llama.cpp UI for the specified instance
// @Tags backends
// @Tags Llama.cpp
// @Security ApiKeyAuth
// @Produce html
// @Param name query string true "Instance Name"
@@ -83,7 +83,7 @@ func (h *Handler) LlamaCppUIProxy() http.HandlerFunc {
// LlamaCppProxy godoc
// @Summary Proxy requests to llama.cpp server instance
// @Description Proxies requests to the specified llama.cpp server instance, starting it on-demand if configured
// @Tags backends
// @Tags Llama.cpp
// @Security ApiKeyAuth
// @Produce json
// @Param name path string true "Instance Name"
@@ -160,7 +160,7 @@ func parseHelper(w http.ResponseWriter, r *http.Request, backend interface {
// ParseLlamaCommand godoc
// @Summary Parse llama-server command
// @Description Parses a llama-server command string into instance options
// @Tags backends
// @Tags Backends
// @Security ApiKeyAuth
// @Accept json
// @Produce json
@@ -190,7 +190,7 @@ func (h *Handler) ParseLlamaCommand() http.HandlerFunc {
// ParseMlxCommand godoc
// @Summary Parse mlx_lm.server command
// @Description Parses MLX-LM server command string into instance options
// @Tags backends
// @Tags Backends
// @Security ApiKeyAuth
// @Accept json
// @Produce json
@@ -219,7 +219,7 @@ func (h *Handler) ParseMlxCommand() http.HandlerFunc {
// ParseVllmCommand godoc
// @Summary Parse vllm serve command
// @Description Parses a vLLM serve command string into instance options
// @Tags backends
// @Tags Backends
// @Security ApiKeyAuth
// @Accept json
// @Produce json
@@ -261,7 +261,7 @@ func (h *Handler) executeLlamaServerCommand(flag, errorMsg string) http.HandlerF
// LlamaServerHelpHandler godoc
// @Summary Get help for llama server
// @Description Returns the help text for the llama server command
// @Tags backends
// @Tags Backends
// @Security ApiKeyAuth
// @Produces text/plain
// @Success 200 {string} string "Help text"
@@ -274,7 +274,7 @@ func (h *Handler) LlamaServerHelpHandler() http.HandlerFunc {
// LlamaServerVersionHandler godoc
// @Summary Get version of llama server
// @Description Returns the version of the llama server command
// @Tags backends
// @Tags Backends
// @Security ApiKeyAuth
// @Produces text/plain
// @Success 200 {string} string "Version information"
@@ -287,7 +287,7 @@ func (h *Handler) LlamaServerVersionHandler() http.HandlerFunc {
// LlamaServerListDevicesHandler godoc
// @Summary List available devices for llama server
// @Description Returns a list of available devices for the llama server
// @Tags backends
// @Tags Backends
// @Security ApiKeyAuth
// @Produces text/plain
// @Success 200 {string} string "List of devices"

View File

@@ -16,7 +16,7 @@ import (
// ListInstances godoc
// @Summary List all instances
// @Description Returns a list of all instances managed by the server
// @Tags instances
// @Tags Instances
// @Security ApiKeyAuth
// @Produces json
// @Success 200 {array} instance.Instance "List of instances"
@@ -37,7 +37,7 @@ func (h *Handler) ListInstances() http.HandlerFunc {
// CreateInstance godoc
// @Summary Create and start a new instance
// @Description Creates a new instance with the provided configuration options
// @Tags instances
// @Tags Instances
// @Security ApiKeyAuth
// @Accept json
// @Produces json
@@ -75,7 +75,7 @@ func (h *Handler) CreateInstance() http.HandlerFunc {
// GetInstance godoc
// @Summary Get details of a specific instance
// @Description Returns the details of a specific instance by name
// @Tags instances
// @Tags Instances
// @Security ApiKeyAuth
// @Produces json
// @Param name path string true "Instance Name"
@@ -105,7 +105,7 @@ func (h *Handler) GetInstance() http.HandlerFunc {
// UpdateInstance godoc
// @Summary Update an instance's configuration
// @Description Updates the configuration of a specific instance by name
// @Tags instances
// @Tags Instances
// @Security ApiKeyAuth
// @Accept json
// @Produces json
@@ -143,7 +143,7 @@ func (h *Handler) UpdateInstance() http.HandlerFunc {
// StartInstance godoc
// @Summary Start a stopped instance
// @Description Starts a specific instance by name
// @Tags instances
// @Tags Instances
// @Security ApiKeyAuth
// @Produces json
// @Param name path string true "Instance Name"
@@ -179,7 +179,7 @@ func (h *Handler) StartInstance() http.HandlerFunc {
// StopInstance godoc
// @Summary Stop a running instance
// @Description Stops a specific instance by name
// @Tags instances
// @Tags Instances
// @Security ApiKeyAuth
// @Produces json
// @Param name path string true "Instance Name"
@@ -209,7 +209,7 @@ func (h *Handler) StopInstance() http.HandlerFunc {
// RestartInstance godoc
// @Summary Restart a running instance
// @Description Restarts a specific instance by name
// @Tags instances
// @Tags Instances
// @Security ApiKeyAuth
// @Produces json
// @Param name path string true "Instance Name"
@@ -239,7 +239,7 @@ func (h *Handler) RestartInstance() http.HandlerFunc {
// DeleteInstance godoc
// @Summary Delete an instance
// @Description Stops and removes a specific instance by name
// @Tags instances
// @Tags Instances
// @Security ApiKeyAuth
// @Param name path string true "Instance Name"
// @Success 204 "No Content"
@@ -267,7 +267,7 @@ func (h *Handler) DeleteInstance() http.HandlerFunc {
// GetInstanceLogs godoc
// @Summary Get logs from a specific instance
// @Description Returns the logs from a specific instance by name with optional line limit
// @Tags instances
// @Tags Instances
// @Security ApiKeyAuth
// @Param name path string true "Instance Name"
// @Param lines query string false "Number of lines to retrieve (default: all lines)"
@@ -310,7 +310,7 @@ func (h *Handler) GetInstanceLogs() http.HandlerFunc {
// InstanceProxy godoc
// @Summary Proxy requests to a specific instance, does not autostart instance if stopped
// @Description Forwards HTTP requests to the llama-server instance running on a specific port
// @Tags instances
// @Tags Instances
// @Security ApiKeyAuth
// @Param name path string true "Instance Name"
// @Success 200 "Request successfully proxied to instance"

View File

@@ -14,7 +14,7 @@ type NodeResponse struct {
// ListNodes godoc
// @Summary List all configured nodes
// @Description Returns a map of all nodes configured in the server (node name -> node config)
// @Tags nodes
// @Tags Nodes
// @Security ApiKeyAuth
// @Produces json
// @Success 200 {object} map[string]NodeResponse "Map of nodes"
@@ -37,7 +37,7 @@ func (h *Handler) ListNodes() http.HandlerFunc {
// GetNode godoc
// @Summary Get details of a specific node
// @Description Returns the details of a specific node by name
// @Tags nodes
// @Tags Nodes
// @Security ApiKeyAuth
// @Produces json
// @Param name path string true "Node Name"

View File

@@ -25,7 +25,7 @@ type OpenAIInstance struct {
// OpenAIListInstances godoc
// @Summary List instances in OpenAI-compatible format
// @Description Returns a list of instances in a format compatible with OpenAI API
// @Tags openai
// @Tags OpenAI
// @Security ApiKeyAuth
// @Produces json
// @Success 200 {object} OpenAIListInstancesResponse "List of OpenAI-compatible instances"
@@ -61,7 +61,7 @@ func (h *Handler) OpenAIListInstances() http.HandlerFunc {
// OpenAIProxy godoc
// @Summary OpenAI-compatible proxy endpoint
// @Description Handles all POST requests to /v1/*, routing to the appropriate instance based on the request body. Requires API key authentication via the `Authorization` header.
// @Tags openai
// @Tags OpenAI
// @Security ApiKeyAuth
// @Accept json
// @Produces json

View File

@@ -8,7 +8,7 @@ import (
// VersionHandler godoc
// @Summary Get llamactl version
// @Description Returns the version of the llamactl command
// @Tags version
// @Tags System
// @Security ApiKeyAuth
// @Produces text/plain
// @Success 200 {string} string "Version information"