docs(serverless_jobs): add documentation for command, timezone and schedule fields (#483)

Author: scaleway-bot

scaleway-async/scaleway_async/jobs/v1alpha1/api.py

@@ -64,7 +64,7 @@ async def create_job_definition(
         :param cpu_limit: CPU limit of the job.
         :param memory_limit: Memory limit of the job (in MiB).
         :param image_uri: Image to use for the job.
-        :param command: Startup command.
+        :param command: Startup command. If empty or not defined, the image's default command is used.
         :param description: Description of the job.
         :param region: Region to target. If none is passed will use default region from the config.
         :param name: Name of the job definition.

scaleway-async/scaleway_async/jobs/v1alpha1/types.py

@@ -48,8 +48,14 @@ def __str__(self) -> str:
 @dataclass
 class CronSchedule:
     schedule: str
+    """
+    UNIX cron schedule to run job (e.g., '* * * * *').
+    """
 
     timezone: str
+    """
+    Timezone for the cron schedule, in tz database format (e.g., 'Europe/Paris').
+    """
 
 
 @dataclass
@@ -159,7 +165,7 @@ class CreateJobDefinitionRequest:
 
     command: str
     """
-    Startup command.
+    Startup command. If empty or not defined, the image's default command is used.
     """
 
     description: str

scaleway/scaleway/jobs/v1alpha1/api.py

@@ -64,7 +64,7 @@ def create_job_definition(
         :param cpu_limit: CPU limit of the job.
         :param memory_limit: Memory limit of the job (in MiB).
         :param image_uri: Image to use for the job.
-        :param command: Startup command.
+        :param command: Startup command. If empty or not defined, the image's default command is used.
         :param description: Description of the job.
         :param region: Region to target. If none is passed will use default region from the config.
         :param name: Name of the job definition.

scaleway/scaleway/jobs/v1alpha1/types.py

@@ -48,8 +48,14 @@ def __str__(self) -> str:
 @dataclass
 class CronSchedule:
     schedule: str
+    """
+    UNIX cron schedule to run job (e.g., '* * * * *').
+    """
 
     timezone: str
+    """
+    Timezone for the cron schedule, in tz database format (e.g., 'Europe/Paris').
+    """
 
 
 @dataclass
@@ -159,7 +165,7 @@ class CreateJobDefinitionRequest:
 
     command: str
     """
-    Startup command.
+    Startup command. If empty or not defined, the image's default command is used.
     """
 
     description: str