doc

Author: pcrespov

services/api-server/openapi.json

@@ -4593,7 +4593,6 @@
           "studies"
         ],
         "summary": "Create Study Job",
-        "description": "hidden -- if True (default) hides project from UI",
         "operationId": "create_study_job",
         "security": [
           {
@@ -4617,9 +4616,11 @@
             "required": false,
             "schema": {
               "type": "boolean",
+              "description": "If True (default) hides project from UI",
               "default": true,
               "title": "Hidden"
-            }
+            },
+            "description": "If True (default) hides project from UI"
           },
           {
             "name": "x-simcore-parent-project-uuid",

services/api-server/src/simcore_service_api_server/_service_studies.py

@@ -74,6 +74,7 @@ async def list_jobs(
 
     async def create_job(
         self,
+        *,
         study_id: StudyID,
         job_inputs: JobInputs,
         hidden: bool = True,

services/api-server/src/simcore_service_api_server/api/routes/studies_jobs.py

@@ -116,11 +116,13 @@ async def create_study_job(
     job_inputs: JobInputs,
     study_service: Annotated[StudyService, Depends(get_study_service)],
     url_for: Annotated[Callable, Depends(get_reverse_url_mapper)],
+    # Filters
     hidden: Annotated[  # noqa: FBT002
-        bool, Query(description="If True (default) hides project from UI")
+        bool, Query(description="Hide this study in web UI (default: True)")
     ] = True,
-    x_simcore_parent_project_uuid: ProjectID | None = Header(default=None),
-    x_simcore_parent_node_id: NodeID | None = Header(default=None),
+    # Headers
+    x_simcore_parent_project_uuid: Annotated[ProjectID | None, Header()] = None,
+    x_simcore_parent_node_id: Annotated[NodeID | None, Header()] = None,
 ) -> Job:
 
     job = await study_service.create_job(