docs(serverless_jobs): add documentation (#405)

Author: scaleway-bot

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

@@ -54,6 +54,18 @@ async def create_job_definition(
         job_timeout: Optional[str] = None,
     ) -> JobDefinition:
         """
+        Create a new job definition in a specified Project.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param name: Name of the job definition.
+        :param cpu_limit: CPU limit of the job.
+        :param memory_limit: Memory limit of the job.
+        :param image_uri: Image to use for the job.
+        :param command: Startup command.
+        :param project_id: UUID of the Scaleway Project containing the job.
+        :param environment_variables: Environment variables of the job.
+        :param description: Description of the job.
+        :param job_timeout: Timeout of the job in seconds.
+        :return: :class:`JobDefinition <JobDefinition>`
 
         Usage:
         ::
@@ -101,6 +113,10 @@ async def get_job_definition(
         region: Optional[Region] = None,
     ) -> JobDefinition:
         """
+        Get a job definition by its unique identifier.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param job_definition_id: UUID of the job definition to get.
+        :return: :class:`JobDefinition <JobDefinition>`
 
         Usage:
         ::
@@ -133,6 +149,13 @@ async def list_job_definitions(
         project_id: Optional[str] = None,
     ) -> ListJobDefinitionsResponse:
         """
+        List all your job definitions with filters.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param page:
+        :param page_size:
+        :param order_by:
+        :param project_id:
+        :return: :class:`ListJobDefinitionsResponse <ListJobDefinitionsResponse>`
 
         Usage:
         ::
@@ -168,6 +191,12 @@ async def list_job_definitions_all(
         project_id: Optional[str] = None,
     ) -> List[JobDefinition]:
         """
+        List all your job definitions with filters.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param page:
+        :param page_size:
+        :param order_by:
+        :param project_id:
         :return: :class:`List[ListJobDefinitionsResponse] <List[ListJobDefinitionsResponse]>`
 
         Usage:
@@ -204,6 +233,18 @@ async def update_job_definition(
         job_timeout: Optional[str] = None,
     ) -> JobDefinition:
         """
+        Update an existing job definition associated with the specified unique identifier.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param job_definition_id: UUID of the job definition to update.
+        :param name: Name of the job definition.
+        :param cpu_limit: CPU limit of the job.
+        :param memory_limit: Memory limit of the job.
+        :param image_uri: Image to use for the job.
+        :param command: Startup command.
+        :param environment_variables: Environment variables of the job.
+        :param description: Description of the job.
+        :param job_timeout: Timeout of the job in seconds.
+        :return: :class:`JobDefinition <JobDefinition>`
 
         Usage:
         ::
@@ -248,6 +289,9 @@ async def delete_job_definition(
         region: Optional[Region] = None,
     ) -> Optional[None]:
         """
+        Delete an exsisting job definition by its unique identifier.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param job_definition_id: UUID of the job definition to delete.
 
         Usage:
         ::
@@ -277,6 +321,10 @@ async def start_job_definition(
         region: Optional[Region] = None,
     ) -> JobRun:
         """
+        Run an existing job definition by its unique identifier. This will create a new job run.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param job_definition_id: UUID of the job definition to start.
+        :return: :class:`JobRun <JobRun>`
 
         Usage:
         ::
@@ -306,6 +354,10 @@ async def get_job_run(
         region: Optional[Region] = None,
     ) -> JobRun:
         """
+        Get a job run by its unique identifier.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param job_run_id: UUID of the job run to get.
+        :return: :class:`JobRun <JobRun>`
 
         Usage:
         ::
@@ -333,6 +385,10 @@ async def stop_job_run(
         region: Optional[Region] = None,
     ) -> JobRun:
         """
+        Stop a job run by its unique identifier.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param job_run_id: UUID of the job run to stop.
+        :return: :class:`JobRun <JobRun>`
 
         Usage:
         ::
@@ -364,6 +420,14 @@ async def list_job_runs(
         project_id: Optional[str] = None,
     ) -> ListJobRunsResponse:
         """
+        List all job runs with filters.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param page:
+        :param page_size:
+        :param order_by:
+        :param job_definition_id:
+        :param project_id:
+        :return: :class:`ListJobRunsResponse <ListJobRunsResponse>`
 
         Usage:
         ::
@@ -401,6 +465,13 @@ async def list_job_runs_all(
         project_id: Optional[str] = None,
     ) -> List[JobRun]:
         """
+        List all job runs with filters.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param page:
+        :param page_size:
+        :param order_by:
+        :param job_definition_id:
+        :param project_id:
         :return: :class:`List[ListJobRunsResponse] <List[ListJobRunsResponse]>`
 
         Usage:

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

@@ -122,22 +122,49 @@ class CreateJobDefinitionRequest:
     """
 
     name: Optional[str]
+    """
+    Name of the job definition.
+    """
 
     cpu_limit: int
+    """
+    CPU limit of the job.
+    """
 
     memory_limit: int
+    """
+    Memory limit of the job.
+    """
 
     image_uri: str
+    """
+    Image to use for the job.
+    """
 
     command: str
+    """
+    Startup command.
+    """
 
     project_id: Optional[str]
+    """
+    UUID of the Scaleway Project containing the job.
+    """
 
     environment_variables: Optional[Dict[str, str]]
+    """
+    Environment variables of the job.
+    """
 
     description: str
+    """
+    Description of the job.
+    """
 
     job_timeout: Optional[str]
+    """
+    Timeout of the job in seconds.
+    """
 
 
 @dataclass
@@ -148,6 +175,9 @@ class GetJobDefinitionRequest:
     """
 
     job_definition_id: str
+    """
+    UUID of the job definition to get.
+    """
 
 
 @dataclass
@@ -174,22 +204,49 @@ class UpdateJobDefinitionRequest:
     """
 
     job_definition_id: str
+    """
+    UUID of the job definition to update.
+    """
 
     name: Optional[str]
+    """
+    Name of the job definition.
+    """
 
     cpu_limit: Optional[int]
+    """
+    CPU limit of the job.
+    """
 
     memory_limit: Optional[int]
+    """
+    Memory limit of the job.
+    """
 
     image_uri: Optional[str]
+    """
+    Image to use for the job.
+    """
 
     command: Optional[str]
+    """
+    Startup command.
+    """
 
     environment_variables: Optional[Dict[str, str]]
+    """
+    Environment variables of the job.
+    """
 
     description: Optional[str]
+    """
+    Description of the job.
+    """
 
     job_timeout: Optional[str]
+    """
+    Timeout of the job in seconds.
+    """
 
 
 @dataclass
@@ -200,6 +257,9 @@ class DeleteJobDefinitionRequest:
     """
 
     job_definition_id: str
+    """
+    UUID of the job definition to delete.
+    """
 
 
 @dataclass
@@ -210,6 +270,9 @@ class StartJobDefinitionRequest:
     """
 
     job_definition_id: str
+    """
+    UUID of the job definition to start.
+    """
 
 
 @dataclass
@@ -220,6 +283,9 @@ class GetJobRunRequest:
     """
 
     job_run_id: str
+    """
+    UUID of the job run to get.
+    """
 
 
 @dataclass
@@ -230,6 +296,9 @@ class StopJobRunRequest:
     """
 
     job_run_id: str
+    """
+    UUID of the job run to stop.
+    """
 
 
 @dataclass