Skip to content

Commit

Permalink
docs: adjust api_timeout, api_ssl_verify, api_wait_events
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasheld committed May 25, 2023
1 parent f7726c4 commit 5776576
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions plugins/doc_fragments/uptime_kuma.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,26 @@ class ModuleDocFragment(object):
description: The Uptime Kuma URL.
type: str
default: http://127.0.0.1:3001
api_wait_timeout:
description: "How many seconds the client should wait for the connection (default: 1)."
api_timeout:
description: How many seconds the client should wait for the connection, an expected event or a server response.
type: float
default: 1
default: 10
api_headers:
description: Headers that are passed to the socketio connection.
type: dict
api_ssl_verify:
description:
- true to verify SSL certificates, or false to skip SSL certificate verification,
- allowing connections to servers with self signed certificates.
type: bool
default: true
api_wait_events:
description:
- How many seconds the client should wait for the next event of the same type.
- There is no way to determine when the last message of a certain type has arrived. Therefore, a timeout is required.
- If no further message has arrived within this time, it is assumed that it was the last message.
type: float
default: 0.2
api_username:
description:
- The Uptime Kuma username.
Expand Down

0 comments on commit 5776576

Please sign in to comment.