Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix return value documentation (1/2) #63477

Merged
merged 3 commits into from
Oct 15, 2019
Merged

Fix return value documentation (1/2) #63477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c0701e0
Fix return value documentation (1/2).
felixfontein Oct 14, 2019
29d52af
Avoid validation errors for missing 'contains:'.
felixfontein Oct 14, 2019
cbeb24a
Forgot two entries.
felixfontein Oct 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
26 changes: 13 additions & 13 deletions lib/ansible/modules/cloud/amazon/aws_codebuild.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,19 +195,19 @@
type: complex
contains:
name:
descriptoin: Name of the CodeBuild project
description: Name of the CodeBuild project
returned: always
type: string
type: str
sample: my_project
arn:
description: ARN of the CodeBuild project
returned: always
type: string
type: str
sample: arn:aws:codebuild:us-east-1:123123123:project/vod-api-app-builder
description:
description: A description of the build project
returned: always
type: string
type: str
sample: My nice little project
source:
description: Information about the build input source code.
Expand All @@ -217,22 +217,22 @@
type:
description: The type of the repository
returned: always
type: string
type: str
sample: CODEPIPELINE
location:
description: Location identifier, depending on the source type.
returned: when configured
type: string
type: str
git_clone_depth:
description: The git clone depth
returned: when configured
type: int
build_spec:
description: The build spec declaration to use for the builds in this build project.
returned: always
type: string
type: str
auth:
desription: Information about the authorization settings for AWS CodeBuild to access the source code to be built.
description: Information about the authorization settings for AWS CodeBuild to access the source code to be built.
returned: when configured
type: complex
insecure_ssl:
Expand All @@ -247,12 +247,12 @@
type:
description: The type of build artifact.
returned: always
type: string
type: str
sample: CODEPIPELINE
location:
description: Output location for build artifacts
returned: when configured
type: string
type: str
# and more... see http://boto3.readthedocs.io/en/latest/reference/services/codebuild.html#CodeBuild.Client.create_project
cache:
description: Cache settings for the build project.
Expand All @@ -265,7 +265,7 @@
service_role:
description: IAM role to be used during build to access other AWS services.
returned: always
type: string
type: str
sample: arn:aws:iam::123123123:role/codebuild-service-role
timeout_in_minutes:
description: The timeout of a build in minutes
Expand All @@ -279,8 +279,8 @@
created:
description: Timestamp of the create time of the project
returned: always
type: string
sample: 2018-04-17T16:56:03.245000+02:00
type: str
sample: "2018-04-17T16:56:03.245000+02:00"
'''

from ansible.module_utils.aws.core import AnsibleAWSModule, get_boto3_client_method_parameters
Expand Down
10 changes: 5 additions & 5 deletions lib/ansible/modules/cloud/amazon/aws_codepipeline.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,12 +146,12 @@
name:
description: Name of the CodePipeline
returned: always
type: string
type: str
sample: my_deploy_pipeline
role_arn:
description: ARN of the IAM role attached to the code pipeline
returned: always
type: string
type: str
sample: arn:aws:iam::123123123:role/codepipeline-service-role
artifact_store:
description: Information about where the build artifacts are stored
Expand All @@ -161,17 +161,17 @@
type:
description: The type of the artifacts store, such as S3
returned: always
type: string
type: str
sample: S3
location:
description: The location of the artifacts storage (s3 bucket name)
returned: always
type: string
type: str
sample: my_s3_codepipline_bucket
encryption_key:
description: The encryption key used to encrypt the artifacts store, such as an AWS KMS key.
returned: when configured
type: string
type: str
stages:
description: List of stages configured for this pipeline
returned: always
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/cloud/amazon/aws_kms.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@
description: Date of creation of the grant
type: str
returned: always
sample: 2017-04-18T15:12:08+10:00
sample: "2017-04-18T15:12:08+10:00"
grant_id:
description: The unique ID for the grant
type: str
Expand Down
4 changes: 2 additions & 2 deletions lib/ansible/modules/cloud/amazon/aws_kms_info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
description: Date of creation of the key
type: str
returned: always
sample: 2017-04-18T15:12:08.551000+10:00
sample: "2017-04-18T15:12:08.551000+10:00"
description:
description: Description of the key
type: str
Expand Down Expand Up @@ -179,7 +179,7 @@
description: Date of creation of the grant
type: str
returned: always
sample: 2017-04-18T15:12:08+10:00
sample: "2017-04-18T15:12:08+10:00"
grant_id:
description: The unique ID for the grant
type: str
Expand Down
8 changes: 4 additions & 4 deletions lib/ansible/modules/cloud/amazon/aws_secret.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,22 +94,22 @@
arn:
description: The ARN of the secret
returned: always
type: string
type: str
sample: arn:aws:secretsmanager:eu-west-1:xxxxxxxxxx:secret:xxxxxxxxxxx
last_accessed_date:
description: The date the secret was last accessed
returned: always
type: string
type: str
sample: '2018-11-20T01:00:00+01:00'
last_changed_date:
description: The date the secret was last modified.
returned: always
type: string
type: str
sample: '2018-11-20T12:16:38.433000+01:00'
name:
description: The secret name.
returned: always
type: string
type: str
sample: my_secret
rotation_enabled:
description: The secret rotation status.
Expand Down
40 changes: 20 additions & 20 deletions lib/ansible/modules/cloud/amazon/ec2_vpc_vpn_info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,26 +120,26 @@
returned: always
type: int
sample: 0
last_status_change:
description: The date and time of the last change in status.
returned: always
type: datetime
sample: 2018-02-09T14:35:27+00:00
outside_ip_address:
description: The Internet-routable IP address of the virtual private gateway's outside interface.
returned: always
type: str
sample: 13.127.79.191
status:
description: The status of the VPN tunnel.
returned: always
type: str
sample: DOWN
status_message:
description: If an error occurs, a description of the error.
returned: always
type: str
sample: IPSEC IS DOWN
last_status_change:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, thanks for catching that. There was recently a new one added that may be returned too:

certificate_arn:
    description: The Amazon Resource Name of the virtual private gateway tunnel endpoint certificate.
    returned: when a private certificate is used for authentication
    type: str
    sample: "arn:aws:acm:us-east-1:123456789101:certificate/c544d8ce-20b8-4fff-98b0-example"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed on IRC, this will be added in a follow-up PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added it to #63541.

description: The date and time of the last change in status.
returned: always
type: datetime
sample: "2018-02-09T14:35:27+00:00"
outside_ip_address:
description: The Internet-routable IP address of the virtual private gateway's outside interface.
returned: always
type: str
sample: 13.127.79.191
status:
description: The status of the VPN tunnel.
returned: always
type: str
sample: DOWN
status_message:
description: If an error occurs, a description of the error.
returned: always
type: str
sample: IPSEC IS DOWN
vpn_connection_id:
description: The ID of the VPN connection.
returned: always
Expand Down
6 changes: 3 additions & 3 deletions lib/ansible/modules/cloud/amazon/elb_target_group_info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@
health_check_port:
description: The port to check target health.
returned: always
type: string
type: str
sample: '80'
target:
description: The target metadata.
Expand All @@ -172,7 +172,7 @@
id:
description: The ID of the target.
returned: always
type: string
type: str
sample: i-0123456789
port:
description: The port to use to connect with the target.
Expand All @@ -187,7 +187,7 @@
state:
description: The state of the target health.
returned: always
type: string
type: str
sample: healthy
target_group_name:
description: The name of the target group.
Expand Down