RDS docs don't mention the attributes "endpoint" and "instance" of the return value

[evankroske]

ISSUE TYPE

• Documentation Report

COMPONENT NAME

rds

ANSIBLE VERSION

2.4

CONFIGURATION

N/A

OS / ENVIRONMENT

N/A

SUMMARY

The attributes "endpoint" and "instance" of the return value of the RDS module aren't documented. The documentation doesn't mention either of them, even though the example code does.

STEPS TO REPRODUCE

1. Go to http://docs.ansible.com/ansible/latest/rds_module.html#return-values.

EXPECTED RESULTS

Find documentation for "endpoint" and "instance".

ACTUAL RESULTS

Don't find documentation for "endpoint" or "instance".

[ansibot]

Files identified in the description:

• lib/ansible/modules/cloud/amazon/rds.py

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

[ansibot]

cc @bpennypacker @willthames
click here for bot help

[lpkirby]

@acozine Thank you for the comments on the PR. I could use some guidance on adding the instance part. As far as I can tell, every one of those return values falls under "instance."

Here is the start of the output when I register and debug print the rds output:

 "msg": {
        "changed": false,
        "failed": false,
        "instance": {
          "allocated_storage": 600,
          "auto_minor_version_upgrade": true,
          "availability_zone": "us-east-1a",
          "backup_retention": 7,
      ....

Perhaps just a note showing how all the return values are referenced using the instance dict?

[acozine]

@lpkirby ah, I see - this is a complex return value, where the main key is an instance or list of instances. This is true for a lot of cloud modules.

Here's an example of documenting complex return values:
https://docs.ansible.com/ansible/devel/modules/ec2_ami_facts_module.html#return-values
Source for that example:
https://github.com/ansible/ansible/blob/devel/lib/ansible/modules/cloud/amazon/ec2_ami_facts.py.

There are more examples, and some tips, in the developer documentation at https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#return-block