Fix rds_snapshot_info return values in docs
#2354
Conversation
Docs Build 📝Thank you for contribution!✨ This PR has been merged and your docs changes will be incorporated when they are next published. |
|
Build succeeded. ✔️ ansible-galaxy-importer SUCCESS in 3m 50s |
|
Build succeeded. ✔️ ansible-galaxy-importer SUCCESS in 9m 04s |
|
@tremble I think this docs update works for now, but I was wondering if we wanted to return a single "snapshots" or rename “snapshots” to “snapshot_instance” to follow the same pattern as “snapshots_cluster". I will be inclined to have a unique returned information called "snapshots" for both cluster and instance. |
|
Build succeeded. ✔️ ansible-galaxy-importer SUCCESS in 5m 11s |
|
Build succeeded (gate pipeline). ✔️ ansible-galaxy-importer SUCCESS in 5m 18s |
|
Pull request merge failed: Required status check "ansible/gate" is expected. |
tremble
force-pushed
the
fix-rds-snapshot-info-docs
branch
from
b24c3f2
to
6cfa014
Compare
|
Build succeeded. ✔️ ansible-galaxy-importer SUCCESS in 4m 24s |
|
Build succeeded (gate pipeline). ✔️ ansible-galaxy-importer SUCCESS in 5m 08s |
softwarefactory-project-zuul
bot
merged commit 786c4b7
into
ansible-collections:main
SUMMARY
There are some inaccuracies and inconsistencies in the documentation for
rds_snapshot_info- specifically, missing return types and fields. This PR corrects these issues, and updates their descriptions to more closely mirror the official AWS documentation.ISSUE TYPE
COMPONENT NAME
rds_snapshot_info
ADDITIONAL INFORMATION
The documentation for
rds_snapshot_infoshow that the module returnscluster_snapshots, but this is only true whendb_cluster_identifierordb_cluster_snapshot_identifieris defined. The module returnssnapshotswhendb_snapshot_identifierordb_instance_identifieris defined instead. This appears to have been introduced in amazon.aws 8.2.0 (specifically, PR #2156 - I have mirrored many of the formatting changes done in that PR when re-adding thesnapshotsobject).Several fields were also missing from the return objects for both
snapshotsandcluster_snapshots, so those have been added. Some descriptions also varied for identical fields insnapshotsandcluster_snapshots, so all descriptions have been updated to match the AWS CLI documentation pages for describe-db-snapshots and describe-db-cluster-snapshots.