Hide HEAD method for /api/jobs/{job_id}/files in API docs

kysrpex · kysrpex · commit 49ac9c3c6474 · 2025-09-11T10:56:52.000+02:00
Including both GET and HEAD in the API schema for the same endpoint is redundant.
diff --git a/lib/galaxy/webapps/galaxy/api/job_files.py b/lib/galaxy/webapps/galaxy/api/job_files.py
@@ -136,7 +136,7 @@ class FastAPIJobFiles:
             )
         ),
     )
-    @router.head(*_args, **_kwargs)  # type: ignore[name-defined]
+    @router.head(*_args, **_kwargs, include_in_schema=False)  # type: ignore[name-defined]
     # remove `@router.head(...)` when ALL endpoints have been migrated to FastAPI
     def index(
         self,

Original file line number	Diff line number	Diff line change
`@@ -136,7 +136,7 @@ class FastAPIJobFiles:`
`136`	`136`	`)`
`137`	`137`	`),`
`138`	`138`	`)`
`139`		`- @router.head(_args, *_kwargs) # type: ignore[name-defined]`
	`139`	`+ @router.head(_args, *_kwargs, include_in_schema=False) # type: ignore[name-defined]`
`140`	`140`	# remove `@router.head(...)` when ALL endpoints have been migrated to FastAPI
`141`	`141`	`def index(`
`142`	`142`	`self,`