updated descriptions and docs

Author: Andrei Neagu

services/dynamic-sidecar/openapi.json

@@ -164,7 +164,8 @@
         "tags": [
           "containers"
         ],
-        "summary": "Starts the containers as defined in ContainerCreate by:\n- cleaning up resources from previous runs if any\n- starting the containers\n\nProgress may be obtained through URL\nProcess may be cancelled through URL",
+        "summary": "Create Containers",
+        "description": "Starts the containers as defined in ContainerCreate by:\n- cleaning up resources from previous runs if any\n- starting the containers\n\nProgress may be obtained through URL\nProcess may be cancelled through URL",
         "operationId": "create_containers_v1_containers_post",
         "requestBody": {
           "required": true,
@@ -336,7 +337,8 @@
         "tags": [
           "containers"
         ],
-        "summary": "Enable/disable ports i/o",
+        "summary": "Toggle Ports Io",
+        "description": "Enable/disable ports i/o",
         "operationId": "toggle_ports_io_v1_containers_ports_io_patch",
         "requestBody": {
           "content": {
@@ -370,7 +372,8 @@
         "tags": [
           "containers"
         ],
-        "summary": "Creates the output directories declared by the docker images's labels. It is more convenient to pass the labels from director-v2, since it already has all the machinery to call into director-v0 to retrieve them.",
+        "summary": "Create Output Dirs",
+        "description": "Creates the output directories declared by the docker images's labels.\nIt is more convenient to pass the labels from director-v2,\nsince it already has all the machinery to call into director-v0\nto retrieve them.",
         "operationId": "create_output_dirs_v1_containers_ports_outputs_dirs_post",
         "requestBody": {
           "content": {
@@ -404,7 +407,8 @@
         "tags": [
           "containers"
         ],
-        "summary": "attach container to a network, if not already attached",
+        "summary": "Attach Container To Network",
+        "description": "attach container to a network, if not already attached",
         "operationId": "attach_container_to_network_v1_containers__id__networks_attach_post",
         "parameters": [
           {
@@ -449,7 +453,8 @@
         "tags": [
           "containers"
         ],
-        "summary": "detach container from a network, if not already detached",
+        "summary": "Detach Container From Network",
+        "description": "detach container from a network, if not already detached",
         "operationId": "detach_container_from_network_v1_containers__id__networks_detach_post",
         "parameters": [
           {
@@ -494,7 +499,8 @@
         "tags": [
           "containers"
         ],
-        "summary": "Pulls all the docker container images for the user services",
+        "summary": "Pull Container Images",
+        "description": "Pulls all the docker container images for the user services",
         "operationId": "pull_container_images_v1_containers_images_pull_post",
         "responses": {
           "202": {
@@ -516,7 +522,8 @@
         "tags": [
           "containers"
         ],
-        "summary": "Remove the previously started containers",
+        "summary": "Down Containers",
+        "description": "Remove the previously started containers",
         "operationId": "down_containers_v1_containers_down_post",
         "responses": {
           "202": {
@@ -538,7 +545,8 @@
         "tags": [
           "containers"
         ],
-        "summary": "Restores the state of the dynamic service",
+        "summary": "Restore Containers State Paths",
+        "description": "Restores the state of the dynamic service",
         "operationId": "restore_containers_state_paths_v1_containers_state_restore_post",
         "responses": {
           "202": {
@@ -560,7 +568,8 @@
         "tags": [
           "containers"
         ],
-        "summary": "Stores the state of the dynamic service",
+        "summary": "Save Containers State Paths",
+        "description": "Stores the state of the dynamic service",
         "operationId": "save_containers_state_paths_v1_containers_state_save_post",
         "responses": {
           "202": {
@@ -582,7 +591,8 @@
         "tags": [
           "containers"
         ],
-        "summary": "Pull input ports data",
+        "summary": "Pull Container Port Inputs",
+        "description": "Pull input ports data",
         "operationId": "pull_container_port_inputs_v1_containers_ports_inputs_pull_post",
         "requestBody": {
           "content": {
@@ -634,7 +644,8 @@
         "tags": [
           "containers"
         ],
-        "summary": "Pull output ports data",
+        "summary": "Pull Container Port Outputs",
+        "description": "Pull output ports data",
         "operationId": "pull_container_port_outputs_v1_containers_ports_outputs_pull_post",
         "requestBody": {
           "content": {
@@ -686,7 +697,8 @@
         "tags": [
           "containers"
         ],
-        "summary": "Push output ports data",
+        "summary": "Push Container Port Outputs",
+        "description": "Push output ports data",
         "operationId": "push_container_port_outputs_v1_containers_ports_outputs_push_post",
         "responses": {
           "202": {
@@ -708,7 +720,8 @@
         "tags": [
           "containers"
         ],
-        "summary": "Restarts previously started user services",
+        "summary": "Restart Containers",
+        "description": "Restarts previously started user services",
         "operationId": "restart_containers_v1_containers_restart_post",
         "responses": {
           "202": {
@@ -730,7 +743,8 @@
         "tags": [
           "volumes"
         ],
-        "summary": "Updates the state of the volume",
+        "summary": "Put Volume State",
+        "description": "Updates the state of the volume",
         "operationId": "put_volume_state_v1_volumes__id__put",
         "parameters": [
           {
@@ -774,7 +788,8 @@
         "tags": [
           "disk"
         ],
-        "summary": "Frees up reserved disk space",
+        "summary": "Free Reserved Disk Space",
+        "description": "Frees up reserved disk space",
         "operationId": "free_reserved_disk_space_v1_disk_reserved_free_post",
         "responses": {
           "204": {

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/api/rest/containers.py

@@ -1,6 +1,3 @@
-# pylint: disable=too-many-arguments
-
-import logging
 from typing import Any
 
 from fastapi import APIRouter, HTTPException
@@ -20,9 +17,6 @@
     MissingDockerComposeDownSpecError,
 )
 
-_logger = logging.getLogger(__name__)
-
-
 router = APIRouter()
 
 

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/api/rest/containers_extension.py

@@ -39,14 +39,14 @@ class DetachContainerFromNetworkItem(_BaseNetworkItem):
 
 @router.patch(
     "/containers/ports/io",
-    summary="Enable/disable ports i/o",
     response_class=Response,
     status_code=status.HTTP_204_NO_CONTENT,
 )
 async def toggle_ports_io(
     patch_ports_io_item: PatchPortsIOItem,
     app: Annotated[FastAPI, Depends(get_application)],
 ) -> None:
+    """Enable/disable ports i/o"""
     await container_extensions.toggle_ports_io(
         app,
         enable_outputs=patch_ports_io_item.enable_outputs,
@@ -56,27 +56,26 @@ async def toggle_ports_io(
 
 @router.post(
     "/containers/ports/outputs/dirs",
-    summary=(
-        "Creates the output directories declared by the docker images's labels. "
-        "It is more convenient to pass the labels from director-v2, "
-        "since it already has all the machinery to call into director-v0 "
-        "to retrieve them."
-    ),
     response_class=Response,
     status_code=status.HTTP_204_NO_CONTENT,
 )
 async def create_output_dirs(
     request_mode: CreateDirsRequestItem,
     app: Annotated[FastAPI, Depends(get_application)],
 ) -> None:
+    """
+    Creates the output directories declared by the docker images's labels.
+    It is more convenient to pass the labels from director-v2,
+    since it already has all the machinery to call into director-v0
+    to retrieve them.
+    """
     await container_extensions.create_output_dirs(
         app, outputs_labels=request_mode.outputs_labels
     )
 
 
 @router.post(
     "/containers/{id}/networks:attach",
-    summary="attach container to a network, if not already attached",
     response_class=Response,
     status_code=status.HTTP_204_NO_CONTENT,
 )
@@ -85,6 +84,7 @@ async def attach_container_to_network(
     item: AttachContainerToNetworkItem,
     container_id: Annotated[str, PathParam(..., alias="id")],
 ) -> None:
+    """attach container to a network, if not already attached"""
     assert request  # nosec
     await container_extensions.attach_container_to_network(
         container_id=container_id,
@@ -95,14 +95,14 @@ async def attach_container_to_network(
 
 @router.post(
     "/containers/{id}/networks:detach",
-    summary="detach container from a network, if not already detached",
     response_class=Response,
     status_code=status.HTTP_204_NO_CONTENT,
 )
 async def detach_container_from_network(
     item: DetachContainerFromNetworkItem,
     container_id: Annotated[str, PathParam(..., alias="id")],
 ) -> None:
+    """detach container from a network, if not already detached"""
     await container_extensions.detach_container_from_network(
         container_id=container_id,
         network_id=item.network_id,