fix(api): correct add-torrent OpenAPI param names and add missing fields (#1426)

Author: s0up4200

internal/web/swagger/openapi.yaml

@@ -1264,10 +1264,46 @@ paths:
                   type: array
                   items:
                     type: string
-                startPaused:
+                paused:
                   type: boolean
-                savePath:
+                savepath:
                   type: string
+                indexer_id:
+                  type: integer
+                  description: Indexer ID for downloading torrent from an indexer
+                skip_checking:
+                  type: boolean
+                sequentialDownload:
+                  type: boolean
+                firstLastPiecePrio:
+                  type: boolean
+                upLimit:
+                  type: integer
+                  description: Upload speed limit in KB/s
+                dlLimit:
+                  type: integer
+                  description: Download speed limit in KB/s
+                ratioLimit:
+                  type: string
+                  description: Share ratio limit
+                seedingTimeLimit:
+                  type: string
+                  description: Seeding time limit in minutes
+                contentLayout:
+                  type: string
+                  description: Content layout (Original, Subfolder, NoSubfolder)
+                rename:
+                  type: string
+                  description: Rename torrent
+                useDownloadPath:
+                  type: boolean
+                  description: Use download path
+                downloadPath:
+                  type: string
+                  description: Download path
+                autoTMM:
+                  type: boolean
+                  description: Automatic torrent management
       responses:
         '201':
           description: Torrent added successfully

internal/web/swagger/openapi_test.go

@@ -4,6 +4,11 @@
 package swagger
 
 import (
+	"go/ast"
+	"go/parser"
+	"go/token"
+	"path/filepath"
+	"runtime"
 	"testing"
 
 	"gopkg.in/yaml.v3"
@@ -105,3 +110,121 @@ func TestOpenAPISecuritySchemes(t *testing.T) {
 		}
 	}
 }
+
+// TestAddTorrentFormFieldsDocumented verifies every r.FormValue() parameter in the
+// add-torrent handler is documented in the OpenAPI spec's multipart schema, and vice versa.
+// This catches mismatches like savePath vs savepath that cause silent API failures.
+func TestAddTorrentFormFieldsDocumented(t *testing.T) {
+	// Locate torrents.go relative to this test file so the test works
+	// regardless of the working directory used by `go test`.
+	_, thisFile, _, ok := runtime.Caller(0)
+	if !ok {
+		t.Fatal("runtime.Caller failed")
+	}
+	handlerPath := filepath.Join(filepath.Dir(thisFile), "..", "..", "api", "handlers", "torrents.go")
+
+	// Parse the handler source with go/parser so we only inspect the
+	// AddTorrent method and extract FormValue string arguments from the AST.
+	fset := token.NewFileSet()
+	file, err := parser.ParseFile(fset, handlerPath, nil, 0)
+	if err != nil {
+		t.Fatalf("Failed to parse torrents handler: %v", err)
+	}
+
+	handlerFields := make(map[string]bool)
+	for _, decl := range file.Decls {
+		fn, ok := decl.(*ast.FuncDecl)
+		if !ok || fn.Name.Name != "AddTorrent" {
+			continue
+		}
+		// Walk the AST of AddTorrent looking for r.FormValue("...") calls.
+		ast.Inspect(fn.Body, func(n ast.Node) bool {
+			call, ok := n.(*ast.CallExpr)
+			if !ok || len(call.Args) != 1 {
+				return true
+			}
+			sel, ok := call.Fun.(*ast.SelectorExpr)
+			if !ok || sel.Sel.Name != "FormValue" {
+				return true
+			}
+			arg, ok := call.Args[0].(*ast.BasicLit)
+			if !ok || arg.Kind != token.STRING {
+				return true
+			}
+			// Strip quotes from the string literal.
+			field := arg.Value[1 : len(arg.Value)-1]
+			handlerFields[field] = true
+			return true
+		})
+	}
+	if len(handlerFields) == 0 {
+		t.Fatal("No FormValue calls found in AddTorrent handler")
+	}
+
+	// Parse the OpenAPI spec and extract properties from the add-torrent endpoint.
+	var spec map[string]any
+	if err := yaml.Unmarshal(openapiYAML, &spec); err != nil {
+		t.Fatalf("Failed to parse OpenAPI spec: %v", err)
+	}
+
+	// Navigate: paths -> /api/instances/{instanceID}/torrents -> post -> requestBody
+	//   -> content -> multipart/form-data -> schema -> properties
+	asMap := func(v any, path string) map[string]any {
+		t.Helper()
+		m, ok := v.(map[string]any)
+		if !ok {
+			t.Fatalf("Expected map at %s, got %T", path, v)
+		}
+		return m
+	}
+	key := func(m map[string]any, k, path string) any {
+		t.Helper()
+		v, ok := m[k]
+		if !ok {
+			t.Fatalf("Missing key %q at %s", k, path)
+		}
+		return v
+	}
+
+	paths := asMap(spec["paths"], "spec.paths")
+	torrentsPath := asMap(key(paths, "/api/instances/{instanceID}/torrents", "paths"), "paths[torrents]")
+	post := asMap(key(torrentsPath, "post", "torrents"), "torrents.post")
+	reqBody := asMap(key(post, "requestBody", "post"), "post.requestBody")
+	content := asMap(key(reqBody, "content", "requestBody"), "requestBody.content")
+	formData := asMap(key(content, "multipart/form-data", "content"), "content[multipart/form-data]")
+	schema := asMap(key(formData, "schema", "formData"), "formData.schema")
+	properties := asMap(key(schema, "properties", "schema"), "schema.properties")
+
+	specFields := make(map[string]bool)
+	for name := range properties {
+		specFields[name] = true
+	}
+
+	// torrentFile is a file upload field, not read via FormValue — exclude it.
+	// urls is read via FormValue but also present in spec.
+	skipHandler := map[string]bool{
+		"torrentFile": true,
+	}
+
+	// Check: every handler field must be in the spec.
+	for field := range handlerFields {
+		if skipHandler[field] {
+			continue
+		}
+		if !specFields[field] {
+			t.Errorf("Handler reads r.FormValue(%q) but OpenAPI spec does not document it", field)
+		}
+	}
+
+	// Check: every spec field must be in the handler (or be torrentFile).
+	for field := range specFields {
+		if skipHandler[field] {
+			continue
+		}
+		if !handlerFields[field] {
+			t.Errorf("OpenAPI spec documents %q but handler does not read it via r.FormValue", field)
+		}
+	}
+
+	t.Logf("Handler fields: %d, Spec fields: %d", len(handlerFields), len(specFields))
+}