fix(functions): add short and long descriptions to triggers methods (#350)

Author: scaleway-bot

scaleway-async/scaleway_async/function/v1beta1/api.py

@@ -1764,6 +1764,22 @@ async def create_trigger(
         sqs_config: Optional[CreateTriggerRequestSqsClientConfig] = None,
     ) -> Trigger:
         """
+        Create a trigger.
+        Create a new trigger for a specified function.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param name: Name of the trigger.
+        :param function_id: ID of the function to trigger.
+        :param description: Description of the trigger.
+        :param scw_sqs_config: Configuration for a Scaleway M&Q SQS queue.
+
+        One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
+        :param scw_nats_config: Configuration for a Scaleway M&Q NATS subject.
+
+        One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
+        :param sqs_config: Configuration for an AWS SQS queue.
+
+        One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
+        :return: :class:`Trigger <Trigger>`
 
         Usage:
         ::
@@ -1805,6 +1821,11 @@ async def get_trigger(
         region: Optional[Region] = None,
     ) -> Trigger:
         """
+        Get a trigger.
+        Get a trigger with a specified ID.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param trigger_id: ID of the trigger to get.
+        :return: :class:`Trigger <Trigger>`
 
         Usage:
         ::
@@ -1872,6 +1893,22 @@ async def list_triggers(
         project_id: Optional[str] = None,
     ) -> ListTriggersResponse:
         """
+        List all triggers.
+        List all triggers belonging to a specified Organization or Project.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param page: Page number to return.
+        :param page_size: Maximum number of triggers to return per page.
+        :param order_by: Order in which to return results.
+        :param function_id: ID of the function the triggers belongs to.
+
+        One-of ('scope'): at most one of 'function_id', 'namespace_id', 'project_id' could be set.
+        :param namespace_id: ID of the namespace the triggers belongs to.
+
+        One-of ('scope'): at most one of 'function_id', 'namespace_id', 'project_id' could be set.
+        :param project_id: ID of the project the triggers belongs to.
+
+        One-of ('scope'): at most one of 'function_id', 'namespace_id', 'project_id' could be set.
+        :return: :class:`ListTriggersResponse <ListTriggersResponse>`
 
         Usage:
         ::
@@ -1917,6 +1954,21 @@ async def list_triggers_all(
         project_id: Optional[str] = None,
     ) -> List[Trigger]:
         """
+        List all triggers.
+        List all triggers belonging to a specified Organization or Project.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param page: Page number to return.
+        :param page_size: Maximum number of triggers to return per page.
+        :param order_by: Order in which to return results.
+        :param function_id: ID of the function the triggers belongs to.
+
+        One-of ('scope'): at most one of 'function_id', 'namespace_id', 'project_id' could be set.
+        :param namespace_id: ID of the namespace the triggers belongs to.
+
+        One-of ('scope'): at most one of 'function_id', 'namespace_id', 'project_id' could be set.
+        :param project_id: ID of the project the triggers belongs to.
+
+        One-of ('scope'): at most one of 'function_id', 'namespace_id', 'project_id' could be set.
         :return: :class:`List[ListTriggersResponse] <List[ListTriggersResponse]>`
 
         Usage:
@@ -1950,6 +2002,16 @@ async def update_trigger(
         sqs_config: Optional[UpdateTriggerRequestSqsClientConfig] = None,
     ) -> Trigger:
         """
+        Update a trigger.
+        Update a trigger with a specified ID.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param trigger_id: ID of the trigger to update.
+        :param name: Name of the trigger.
+        :param description: Description of the trigger.
+        :param sqs_config: Configuration for an AWS SQS queue.
+
+        One-of ('config'): at most one of 'sqs_config' could be set.
+        :return: :class:`Trigger <Trigger>`
 
         Usage:
         ::
@@ -1987,6 +2049,11 @@ async def delete_trigger(
         region: Optional[Region] = None,
     ) -> Trigger:
         """
+        Delete a trigger.
+        Delete a trigger with a specified ID.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param trigger_id: ID of the trigger to delete.
+        :return: :class:`Trigger <Trigger>`
 
         Usage:
         ::

scaleway-async/scaleway_async/function/v1beta1/types.py

@@ -246,14 +246,14 @@ class CreateTriggerRequestMnqNatsClientConfig:
     Create trigger request. mnq nats client config.
     """
 
-    subject: str
+    mnq_namespace_id: Optional[str]
     """
-    Name of the NATS subject the trigger should listen to.
+    :deprecated
     """
 
-    mnq_namespace_id: Optional[str]
+    subject: str
     """
-    :deprecated
+    Name of the NATS subject the trigger should listen to.
     """
 
     mnq_nats_account_id: str
@@ -889,14 +889,14 @@ class TriggerMnqNatsClientConfig:
     Trigger. mnq nats client config.
     """
 
-    mnq_namespace_id: Optional[str]
+    subject: str
     """
-    :deprecated
+    Name of the NATS subject the trigger listens to.
     """
 
-    subject: str
+    mnq_namespace_id: Optional[str]
     """
-    Name of the NATS subject the trigger listens to.
+    :deprecated
     """
 
     mnq_nats_account_id: str
@@ -926,14 +926,14 @@ class TriggerMnqSqsClientConfig:
     Trigger. mnq sqs client config.
     """
 
-    queue: str
+    mnq_namespace_id: Optional[str]
     """
-    Name of the SQS queue the trigger listens to.
+    :deprecated
     """
 
-    mnq_namespace_id: Optional[str]
+    queue: str
     """
-    :deprecated
+    Name of the SQS queue the trigger listens to.
     """
 
     mnq_project_id: str

scaleway/scaleway/function/v1beta1/api.py

@@ -1760,6 +1760,22 @@ def create_trigger(
         sqs_config: Optional[CreateTriggerRequestSqsClientConfig] = None,
     ) -> Trigger:
         """
+        Create a trigger.
+        Create a new trigger for a specified function.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param name: Name of the trigger.
+        :param function_id: ID of the function to trigger.
+        :param description: Description of the trigger.
+        :param scw_sqs_config: Configuration for a Scaleway M&Q SQS queue.
+
+        One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
+        :param scw_nats_config: Configuration for a Scaleway M&Q NATS subject.
+
+        One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
+        :param sqs_config: Configuration for an AWS SQS queue.
+
+        One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
+        :return: :class:`Trigger <Trigger>`
 
         Usage:
         ::
@@ -1801,6 +1817,11 @@ def get_trigger(
         region: Optional[Region] = None,
     ) -> Trigger:
         """
+        Get a trigger.
+        Get a trigger with a specified ID.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param trigger_id: ID of the trigger to get.
+        :return: :class:`Trigger <Trigger>`
 
         Usage:
         ::
@@ -1868,6 +1889,22 @@ def list_triggers(
         project_id: Optional[str] = None,
     ) -> ListTriggersResponse:
         """
+        List all triggers.
+        List all triggers belonging to a specified Organization or Project.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param page: Page number to return.
+        :param page_size: Maximum number of triggers to return per page.
+        :param order_by: Order in which to return results.
+        :param function_id: ID of the function the triggers belongs to.
+
+        One-of ('scope'): at most one of 'function_id', 'namespace_id', 'project_id' could be set.
+        :param namespace_id: ID of the namespace the triggers belongs to.
+
+        One-of ('scope'): at most one of 'function_id', 'namespace_id', 'project_id' could be set.
+        :param project_id: ID of the project the triggers belongs to.
+
+        One-of ('scope'): at most one of 'function_id', 'namespace_id', 'project_id' could be set.
+        :return: :class:`ListTriggersResponse <ListTriggersResponse>`
 
         Usage:
         ::
@@ -1913,6 +1950,21 @@ def list_triggers_all(
         project_id: Optional[str] = None,
     ) -> List[Trigger]:
         """
+        List all triggers.
+        List all triggers belonging to a specified Organization or Project.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param page: Page number to return.
+        :param page_size: Maximum number of triggers to return per page.
+        :param order_by: Order in which to return results.
+        :param function_id: ID of the function the triggers belongs to.
+
+        One-of ('scope'): at most one of 'function_id', 'namespace_id', 'project_id' could be set.
+        :param namespace_id: ID of the namespace the triggers belongs to.
+
+        One-of ('scope'): at most one of 'function_id', 'namespace_id', 'project_id' could be set.
+        :param project_id: ID of the project the triggers belongs to.
+
+        One-of ('scope'): at most one of 'function_id', 'namespace_id', 'project_id' could be set.
         :return: :class:`List[ListTriggersResponse] <List[ListTriggersResponse]>`
 
         Usage:
@@ -1946,6 +1998,16 @@ def update_trigger(
         sqs_config: Optional[UpdateTriggerRequestSqsClientConfig] = None,
     ) -> Trigger:
         """
+        Update a trigger.
+        Update a trigger with a specified ID.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param trigger_id: ID of the trigger to update.
+        :param name: Name of the trigger.
+        :param description: Description of the trigger.
+        :param sqs_config: Configuration for an AWS SQS queue.
+
+        One-of ('config'): at most one of 'sqs_config' could be set.
+        :return: :class:`Trigger <Trigger>`
 
         Usage:
         ::
@@ -1983,6 +2045,11 @@ def delete_trigger(
         region: Optional[Region] = None,
     ) -> Trigger:
         """
+        Delete a trigger.
+        Delete a trigger with a specified ID.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param trigger_id: ID of the trigger to delete.
+        :return: :class:`Trigger <Trigger>`
 
         Usage:
         ::

scaleway/scaleway/function/v1beta1/types.py

@@ -926,14 +926,14 @@ class TriggerMnqSqsClientConfig:
     Trigger. mnq sqs client config.
     """
 
-    queue: str
+    mnq_namespace_id: Optional[str]
     """
-    Name of the SQS queue the trigger listens to.
+    :deprecated
     """
 
-    mnq_namespace_id: Optional[str]
+    queue: str
     """
-    :deprecated
+    Name of the SQS queue the trigger listens to.
     """
 
     mnq_project_id: str