Skip to content

Commit 2d6982a

Browse files
authored
docs(tem): add missing webhook service documentation (#605)
1 parent 668d80e commit 2d6982a

File tree

2 files changed

+26
-0
lines changed
  • scaleway/scaleway/tem/v1alpha1
  • scaleway-async/scaleway_async/tem/v1alpha1

2 files changed

+26
-0
lines changed

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -823,6 +823,8 @@ async def list_webhooks(
823823
domain_id: Optional[str] = None,
824824
) -> ListWebhooksResponse:
825825
"""
826+
List Webhooks.
827+
Retrieve Webhooks in a specific Project or in a specific Organization using the `region` parameter.
826828
:param region: Region to target. If none is passed will use default region from the config.
827829
:param order_by: (Optional) List Webhooks corresponding to specific criteria.
828830
:param page: (Optional) Requested page number. Value must be greater or equal to 1.
@@ -871,6 +873,8 @@ async def list_webhooks_all(
871873
domain_id: Optional[str] = None,
872874
) -> List[Webhook]:
873875
"""
876+
List Webhooks.
877+
Retrieve Webhooks in a specific Project or in a specific Organization using the `region` parameter.
874878
:param region: Region to target. If none is passed will use default region from the config.
875879
:param order_by: (Optional) List Webhooks corresponding to specific criteria.
876880
:param page: (Optional) Requested page number. Value must be greater or equal to 1.
@@ -909,6 +913,7 @@ async def get_webhook(
909913
) -> Webhook:
910914
"""
911915
Get information about a Webhook.
916+
Retrieve information about a specific Webhook using the `webhook_id` and `region` parameters.
912917
:param webhook_id: ID of the Webhook to check.
913918
:param region: Region to target. If none is passed will use default region from the config.
914919
:return: :class:`Webhook <Webhook>`
@@ -944,6 +949,8 @@ async def update_webhook(
944949
sns_arn: Optional[str] = None,
945950
) -> Webhook:
946951
"""
952+
Update a Webhook.
953+
Update a Webhook events type, SNS ARN or name.
947954
:param webhook_id: ID of the Webhook to update.
948955
:param region: Region to target. If none is passed will use default region from the config.
949956
:param name: Name of the Webhook to update.
@@ -989,6 +996,8 @@ async def delete_webhook(
989996
region: Optional[Region] = None,
990997
) -> None:
991998
"""
999+
Delete a Webhook.
1000+
You must specify the Webhook you want to delete by the `region` and `webhook_id`. Deleting a Webhook is permanent and cannot be undone.
9921001
:param webhook_id: ID of the Webhook to delete.
9931002
:param region: Region to target. If none is passed will use default region from the config.
9941003
@@ -1028,6 +1037,8 @@ async def list_webhook_events(
10281037
domain_id: Optional[str] = None,
10291038
) -> ListWebhookEventsResponse:
10301039
"""
1040+
List Webhook triggered events.
1041+
Retrieve the list of Webhook events triggered from a specific Webhook or for a specific Project or Organization. You must specify the `region`.
10311042
:param webhook_id: ID of the Webhook linked to the events.
10321043
:param region: Region to target. If none is passed will use default region from the config.
10331044
:param order_by: (Optional) List Webhook events corresponding to specific criteria.
@@ -1090,6 +1101,8 @@ async def list_webhook_events_all(
10901101
domain_id: Optional[str] = None,
10911102
) -> List[WebhookEvent]:
10921103
"""
1104+
List Webhook triggered events.
1105+
Retrieve the list of Webhook events triggered from a specific Webhook or for a specific Project or Organization. You must specify the `region`.
10931106
:param webhook_id: ID of the Webhook linked to the events.
10941107
:param region: Region to target. If none is passed will use default region from the config.
10951108
:param order_by: (Optional) List Webhook events corresponding to specific criteria.

scaleway/scaleway/tem/v1alpha1/api.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -823,6 +823,8 @@ def list_webhooks(
823823
domain_id: Optional[str] = None,
824824
) -> ListWebhooksResponse:
825825
"""
826+
List Webhooks.
827+
Retrieve Webhooks in a specific Project or in a specific Organization using the `region` parameter.
826828
:param region: Region to target. If none is passed will use default region from the config.
827829
:param order_by: (Optional) List Webhooks corresponding to specific criteria.
828830
:param page: (Optional) Requested page number. Value must be greater or equal to 1.
@@ -871,6 +873,8 @@ def list_webhooks_all(
871873
domain_id: Optional[str] = None,
872874
) -> List[Webhook]:
873875
"""
876+
List Webhooks.
877+
Retrieve Webhooks in a specific Project or in a specific Organization using the `region` parameter.
874878
:param region: Region to target. If none is passed will use default region from the config.
875879
:param order_by: (Optional) List Webhooks corresponding to specific criteria.
876880
:param page: (Optional) Requested page number. Value must be greater or equal to 1.
@@ -909,6 +913,7 @@ def get_webhook(
909913
) -> Webhook:
910914
"""
911915
Get information about a Webhook.
916+
Retrieve information about a specific Webhook using the `webhook_id` and `region` parameters.
912917
:param webhook_id: ID of the Webhook to check.
913918
:param region: Region to target. If none is passed will use default region from the config.
914919
:return: :class:`Webhook <Webhook>`
@@ -944,6 +949,8 @@ def update_webhook(
944949
sns_arn: Optional[str] = None,
945950
) -> Webhook:
946951
"""
952+
Update a Webhook.
953+
Update a Webhook events type, SNS ARN or name.
947954
:param webhook_id: ID of the Webhook to update.
948955
:param region: Region to target. If none is passed will use default region from the config.
949956
:param name: Name of the Webhook to update.
@@ -989,6 +996,8 @@ def delete_webhook(
989996
region: Optional[Region] = None,
990997
) -> None:
991998
"""
999+
Delete a Webhook.
1000+
You must specify the Webhook you want to delete by the `region` and `webhook_id`. Deleting a Webhook is permanent and cannot be undone.
9921001
:param webhook_id: ID of the Webhook to delete.
9931002
:param region: Region to target. If none is passed will use default region from the config.
9941003
@@ -1028,6 +1037,8 @@ def list_webhook_events(
10281037
domain_id: Optional[str] = None,
10291038
) -> ListWebhookEventsResponse:
10301039
"""
1040+
List Webhook triggered events.
1041+
Retrieve the list of Webhook events triggered from a specific Webhook or for a specific Project or Organization. You must specify the `region`.
10311042
:param webhook_id: ID of the Webhook linked to the events.
10321043
:param region: Region to target. If none is passed will use default region from the config.
10331044
:param order_by: (Optional) List Webhook events corresponding to specific criteria.
@@ -1090,6 +1101,8 @@ def list_webhook_events_all(
10901101
domain_id: Optional[str] = None,
10911102
) -> List[WebhookEvent]:
10921103
"""
1104+
List Webhook triggered events.
1105+
Retrieve the list of Webhook events triggered from a specific Webhook or for a specific Project or Organization. You must specify the `region`.
10931106
:param webhook_id: ID of the Webhook linked to the events.
10941107
:param region: Region to target. If none is passed will use default region from the config.
10951108
:param order_by: (Optional) List Webhook events corresponding to specific criteria.

0 commit comments

Comments
 (0)