ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-10-03 23:14:02 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

[PR #10463/d288555f backport][stable-11] doc style adjustments: modules p* (#10468)

Browse source 
doc style adjustments: modules p* (#10463)

* doc style adjustments: modules p*

* Update plugins/modules/pacemaker_resource.py

* Update plugins/modules/pagerduty_alert.py

* Update plugins/modules/pear.py

* Update plugins/modules/portage.py

* reformat

* adjustment from review

* Update plugins/modules/pkg5_publisher.py



---------


(cherry picked from commit d288555fd9)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Co-authored-by: Peter Oliver <github.com@mavit.org.uk>
This commit is contained in:
patchback[bot] 2025-07-27 12:13:47 +02:00 • committed by GitHub
commit 6d8ae5d639
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
30 changed files with 161 additions and 155 deletions
Download patch file Download diff file Expand all files Collapse all files

18
plugins/modules/pubnub_blocks.py
View file

@ -56,13 +56,13 @@ options:
default: {}
account:
description:
- Name of PubNub account for from which O(application) will be used to manage blocks.
- User's account will be used if value not set or empty.
- Name of PubNub account for from which O(application) is used to manage blocks.
- User's account is used if value not set or empty.
type: str
default: ''
application:
description:
- Name of target PubNub application for which blocks configuration on specific O(keyset) will be done.
- Name of target PubNub application for which blocks configuration on specific O(keyset) is done.
type: str
required: true
keyset:
@ -72,19 +72,19 @@ options:
required: true
state:
description:
- Intended block state after event handlers creation / update process will be completed.
- Intended block state after event handlers creation / update process is completed.
required: false
default: 'present'
choices: ['started', 'stopped', 'present', 'absent']
type: str
name:
description:
- Name of managed block which will be later visible on admin.pubnub.com.
- Name of managed block which is later visible on admin.pubnub.com.
required: true
type: str
description:
description:
- Short block description which will be later visible on U(https://admin.pubnub.com).
- Short block description which is later visible on U(https://admin.pubnub.com).
- Used only if block does not exists and does not change description for existing block.
required: false
type: str
@ -99,8 +99,8 @@ options:
- Each entry for existing handlers should contain C(name) (so target handler can be identified). Rest parameters (C(src),
C(channels) and C(event)) can be added if changes required for them.
- It is possible to rename event handler by adding C(changes) key to event handler payload and pass dictionary, which
will contain single key C(name), where new name should be passed.
- To remove particular event handler it is possible to set C(state) for it to C(absent) and it will be removed.
contains single key C(name), where new name should be passed.
- To remove particular event handler it is possible to set C(state) for it to C(absent) and it is removed.
required: false
default: []
type: list
@ -115,7 +115,7 @@ options:
validate_certs:
description:
- This key allow to try skip certificates check when performing REST API calls. Sometimes host may have issues with
certificates on it and this will cause problems to call PubNub REST API.
certificates on it and this causes problems to call PubNub REST API.
- If check should be ignored V(false) should be passed to this parameter.
required: false
default: true