Skip to content

Commit 56b6fee

Browse files
buxellbuxell
committed
Fix YAML syntax in documentation strings
1 parent 4cd4d6f commit 56b6fee

File tree

3 files changed

+36
-27
lines changed

3 files changed

+36
-27
lines changed

‎plugins/modules/medialive_channel.py‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,16 @@
55
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
66

77
DOCUMENTATION = r"""
8+
---
89
module: medialive_channel
9-
short_description: Manage AWS MediaLive Anywhere Channels
1010
version_added: 10.1.0
11+
short_description: Manage AWS MediaLive Anywhere Channels
1112
description:
1213
- A module for creating, updating and deleting AWS MediaLive Channels.
13-
requirements:
14-
- boto3 >= 1.37.30
14+
- This module includes basic functionality for managing channels, but does not include input validation
15+
- Requires boto3 >= 1.37.30
16+
author:
17+
- Sergey Papyan
1518
options:
1619
cdi_input_specification:
1720
description:
@@ -30,7 +33,7 @@
3033
choices: ['STANDARD', 'SINGLE_PIPELINE']
3134
destinations:
3235
description:
33-
- Placeholder documentation for __listOfOutputDestination
36+
- A list of output destinations for this channel. Defines where and how the outputs of the MediaLive channel should be delivered.
3437
type: list
3538
elements: dict
3639
suboptions:
@@ -111,7 +114,8 @@
111114
type: str
112115
logical_interface_names:
113116
description:
114-
- TODO
117+
- A list of logical interface names used for network isolation in MediaLive Anywhere deployments.
118+
115119
type: list
116120
elements: str
117121
encoder_settings:
@@ -2067,7 +2071,6 @@
20672071
type: str
20682072
choices: ['AUTO', 'USE_CONFIGURED']
20692073
audio_buffer_model:
2070-
description:
20712074
description:
20722075
- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, uses ATSC model.
20732076
type: str
@@ -2347,7 +2350,6 @@
23472350
type: dict
23482351
suboptions:
23492352
password_param:
2350-
description:
23512353
description:
23522354
- key used to extract the password from EC2 Parameter store
23532355
type: str
@@ -4234,7 +4236,7 @@
42344236
type: str
42354237
respond_to_afd:
42364238
description:
4237-
- Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH. RESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME_CAPTURE. PASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output. NONE: MediaLive does not clip the input video and does not include the AFD values in the output
4239+
- Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH. RESPOND - MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME_CAPTURE. PASSTHROUGH - MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output. NONE - MediaLive does not clip the input video and does not include the AFD values in the output
42384240
type: str
42394241
choices: ['NONE', 'PASSTHROUGH', 'RESPOND']
42404242
scaling_behavior:
@@ -4707,7 +4709,7 @@
47074709
type: int
47084710
logical_interface_names:
47094711
description:
4710-
- TODO
4712+
- A list of logical interface names used for network isolation in MediaLive Anywhere deployments.
47114713
type: list
47124714
elements: str
47134715
input_specification:
@@ -4815,8 +4817,7 @@
48154817
description:
48164818
- TODO
48174819
type: bool
4818-
author:
4819-
- Sergey Papyan (@yourgithub)
4820+
48204821
extends_documentation_fragment:
48214822
- amazon.aws.common.modules
48224823
- amazon.aws.region.modules

‎plugins/modules/medialive_sdi_source.py‎

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,15 @@
55
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
66

77
DOCUMENTATION = r"""
8+
---
89
module: medialive_sdi_source
9-
short_description: Manage AWS MediaLive Anywhere SDI sources
1010
version_added: 10.1.0
11+
short_description: Manage AWS MediaLive Anywhere SDI sources
1112
description:
1213
- A module for creating, updating and deleting AWS MediaLive Anywhere SDI sources.
1314
- This module requires boto3 >= 1.37.34.
15+
author:
16+
- "Brenton Buxell (@buxell)"
1417
options:
1518
id:
1619
description:
@@ -41,37 +44,41 @@
4144
type:
4245
description:
4346
- Specify the type of the SDI source
44-
- SINGLE: The source is a single-link source
45-
- QUAD: The source is one part of a quad-link source
47+
- SINGLE, the source is a single-link source
48+
- QUAD, the source is one part of a quad-link source
4649
- Defaults to 'SINGLE' when creating a new SDI source
4750
default: 'SINGLE'
4851
type: str
4952
required: false
5053
choices: ['SINGLE', 'QUAD']
5154
52-
author:
53-
- Brenton Buxell (@bbuxell)
5455
extends_documentation_fragment:
5556
- amazon.aws.common.modules
5657
- amazon.aws.region.modules
5758
- amazon.aws.boto3
5859
"""
5960

6061
EXAMPLES = r"""
61-
# Create a MediaLive Anywhere SDI source
62-
- community.aws.medialive_sdi_source:
62+
- name: Create a MediaLive Anywhere SDI source
63+
community.aws.medialive_sdi_source:
6364
name: 'ExampleSdiSource'
6465
state: present
6566
type: 'QUAD'
6667
mode: 'INTERLEAVE'
6768
68-
# Delete a MediaLive Anywhere SDI source
69-
- community.aws.medialive_sdi_source:
69+
- name: Delete a MediaLive Anywhere SDI source
70+
community.aws.medialive_sdi_source:
7071
name: 'ExampleSdiSource'
7172
state: absent
7273
"""
7374

7475
RETURN = r"""
76+
changed:
77+
description: if a MediaLive SDI Source has been created, updated or deleted
78+
returned: always
79+
type: bool
80+
sample:
81+
changed: true
7582
sdi_source:
7683
description: The details of the SDI source
7784
returned: success

‎plugins/modules/medialive_sdi_source_info.py‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,15 @@
55
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
66

77
DOCUMENTATION = r"""
8+
---
89
module: medialive_sdi_source_info
9-
short_description: Gather AWS MediaLive Anywhere SDI source info
1010
version_added: 10.1.0
11+
short_description: Gather AWS MediaLive Anywhere SDI source info
1112
description:
1213
- Get details about a AWS MediaLive Anywhere SDI source.
1314
- This module requires boto3 >= 1.37.30.
15+
author:
16+
- Brenton Buxell (@bbuxell)
1417
options:
1518
id:
1619
description:
@@ -25,8 +28,6 @@
2528
type: str
2629
aliases: ['sdi_source_name']
2730
28-
author:
29-
- Brenton Buxell (@bbuxell)
3031
extends_documentation_fragment:
3132
- amazon.aws.common.modules
3233
- amazon.aws.region.modules
@@ -35,13 +36,13 @@
3536
"""
3637

3738
EXAMPLES = r"""
38-
# Create a MediaLive Anywhere SDI source by name
39-
- community.aws.medialive_sdi_source_info:
39+
- name: Create a MediaLive Anywhere SDI source by name
40+
community.aws.medialive_sdi_source_info:
4041
name: 'ExampleSdiSource'
4142
register: found_source
4243
43-
# Create a MediaLive Anywhere SDI source by ID
44-
- community.aws.medialive_sdi_source_info:
44+
- name: Create a MediaLive Anywhere SDI source by ID
45+
community.aws.medialive_sdi_source_info:
4546
id: '1234567'
4647
register: found_source
4748
"""

0 commit comments

Comments
 (0)