Mirrored_Repos/crafty-4
1
0
Fork 0
mirror of https://gitlab.com/crafty-controller/crafty-4.git synced 2024-08-30 18:23:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add missing bot_name params in webhook docstrings

Browse Source
This commit is contained in:
Zedifus 2023-10-06 19:20:53 +01:00
parent d6f93368be
commit d10de65c5a
3 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
app/classes/web/webhooks/discord_webhook.py
View File

@ -15,6 +15,7 @@ class DiscordWebhook(WebhookProvider):
title (str): The title for the notification message. title (str): The title for the notification message.
message (str): The main content of the notification message. message (str): The main content of the notification message.
color (int): The color code for the side stripe in the Discord embed message. color (int): The color code for the side stripe in the Discord embed message.
bot_name (str): Override for the Webhook's name set on creation
Returns: Returns:
tuple: A tuple containing the constructed payload (dict) incl headers (dict). tuple: A tuple containing the constructed payload (dict) incl headers (dict).
@ -60,6 +61,7 @@ class DiscordWebhook(WebhookProvider):
message (str): The main content or body of the notification message. message (str): The main content or body of the notification message.
color (str, optional): The color code for the embed's side stripe. color (str, optional): The color code for the embed's side stripe.
Defaults to a pretty blue if not provided. Defaults to a pretty blue if not provided.
bot_name (str): Override for the Webhook's name set on creation
Returns: Returns:
str: "Dispatch successful!" if the message is sent successfully, otherwise an str: "Dispatch successful!" if the message is sent successfully, otherwise an

2
app/classes/web/webhooks/mattermost_webhook.py
View File

@ -13,6 +13,7 @@ class MattermostWebhook(WebhookProvider):
server_name (str): The name of the server triggering the notification. server_name (str): The name of the server triggering the notification.
title (str): The title for the notification message. title (str): The title for the notification message.
message (str): The main content of the notification message. message (str): The main content of the notification message.
bot_name (str): Override for the Webhook's name set on creation.
Returns: Returns:
tuple: A tuple containing the constructed payload (dict) incl headers (dict). tuple: A tuple containing the constructed payload (dict) incl headers (dict).
@ -52,6 +53,7 @@ class MattermostWebhook(WebhookProvider):
title (str): The title for the notification message. title (str): The title for the notification message.
url (str): The webhook URL to send the notification to. url (str): The webhook URL to send the notification to.
message (str): The main content or body of the notification message. message (str): The main content or body of the notification message.
bot_name (str): Override for the Webhook's name set on creation, see note!
Returns: Returns:
str: "Dispatch successful!" if the message is sent successfully, otherwise an str: "Dispatch successful!" if the message is sent successfully, otherwise an

2
app/classes/web/webhooks/slack_webhook.py
View File

@ -14,6 +14,7 @@ class SlackWebhook(WebhookProvider):
title (str): The title for the notification message. title (str): The title for the notification message.
message (str): The main content of the notification message. message (str): The main content of the notification message.
color (int): The color code for the side stripe in the Slack block. color (int): The color code for the side stripe in the Slack block.
bot_name (str): Override for the Webhook's name set on creation, (not working).
Returns: Returns:
tuple: A tuple containing the constructed payload (dict) incl headers (dict). tuple: A tuple containing the constructed payload (dict) incl headers (dict).
@ -80,6 +81,7 @@ class SlackWebhook(WebhookProvider):
message (str): The main content or body of the notification message. message (str): The main content or body of the notification message.
color (str, optional): The color code for the blocks's colour accent. color (str, optional): The color code for the blocks's colour accent.
Defaults to a pretty blue if not provided. Defaults to a pretty blue if not provided.
bot_name (str): Override for the Webhook's name set on creation, (not working).
Returns: Returns:
str: "Dispatch successful!" if the message is sent successfully, otherwise an str: "Dispatch successful!" if the message is sent successfully, otherwise an