Update return block documentation for rds modules #2156
Conversation
|
Merge Failed. This change or one of its cross-repo dependencies was unable to be automatically merged with the current state of its repository. Please rebase the change and upload a new patchset. |
plugins/modules/rds_snapshot_info.py
Outdated
| description: ID of VPC containing the DB | ||
| returned: always | ||
| type: str | ||
| sample: vpc-abcd1234 | ||
| cluster_snapshots: | ||
| description: List of cluster snapshots |
There was a problem hiding this comment.
| description: List of cluster snapshots | |
| description: List of cluster snapshots. |
plugins/modules/rds_snapshot_info.py
Outdated
| @@ -200,32 +90,32 @@ | |||
| description: Date and time the cluster was created | |||
There was a problem hiding this comment.
| description: Date and time the cluster was created | |
| description: Date and time the cluster was created. |
plugins/modules/rds_snapshot_info.py
Outdated
| @@ -200,32 +90,32 @@ | |||
| description: Date and time the cluster was created | |||
| returned: always | |||
| type: str | |||
| sample: '2018-05-17T00:13:40.223000+00:00' | |||
| sample: "2018-05-17T00:13:40.223000+00:00" | |||
| db_cluster_identifier: | |||
| description: Database cluster identifier | |||
There was a problem hiding this comment.
| description: Database cluster identifier | |
| description: Database cluster identifier. |
plugins/modules/rds_snapshot_info.py
Outdated
| db_cluster_identifier: | ||
| description: Database cluster identifier | ||
| returned: always | ||
| type: str | ||
| sample: test-aurora-cluster | ||
| sample: "test-aurora-cluster" | ||
| db_cluster_snapshot_arn: | ||
| description: ARN of the database snapshot |
There was a problem hiding this comment.
| description: ARN of the database snapshot | |
| description: ARN of the database snapshot. |
plugins/modules/rds_snapshot_info.py
Outdated
| db_cluster_snapshot_arn: | ||
| description: ARN of the database snapshot | ||
| returned: always | ||
| type: str | ||
| sample: arn:aws:rds:ca-central-1:123456789012:cluster-snapshot:test-aurora-snapshot | ||
| sample: "arn:aws:rds:ca-central-1:123456789012:cluster-snapshot:test-aurora-snapshot" | ||
| db_cluster_snapshot_identifier: | ||
| description: Snapshot identifier |
There was a problem hiding this comment.
| description: Snapshot identifier | |
| description: Snapshot identifier. |
plugins/modules/rds_snapshot_info.py
Outdated
| db_cluster_snapshot_identifier: | ||
| description: Snapshot identifier | ||
| returned: always | ||
| type: str | ||
| sample: test-aurora-snapshot | ||
| sample: "test-aurora-snapshot" | ||
| engine: | ||
| description: Database engine |
There was a problem hiding this comment.
| description: Database engine | |
| description: Database engine. |
GomathiselviS
force-pushed
the
rds_return_blk_1
branch
from
6d76fb9 to
3af4966
Compare
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 21s |
GomathiselviS
force-pushed
the
rds_return_blk_1
branch
from
ecb6ce8 to
5070005
Compare
|
Build succeeded. ✔️ ansible-galaxy-importer SUCCESS in 4m 36s |
|
Build succeeded (gate pipeline). ✔️ ansible-galaxy-importer SUCCESS in 4m 31s |
softwarefactory-project-zuul
bot
merged commit 8d37698
into
ansible-collections:main
…s#2156) SUMMARY Refer: https://issues.redhat.com/browse/ACA-1484 This PR updates the return block in the rds module documentation. ISSUE TYPE Docs Pull Request COMPONENT NAME ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis Reviewed-by: Mike Graves <[email protected]> Reviewed-by: Helen Bailey <[email protected]>
Backport to stable-8: 💔 cherry-picking failed — conflicts found❌ Failed to cleanly apply 8d37698 on top of patchback/backports/stable-8/8d376986155cad278e96c449d8901dc4238af117/pr-2156 Backporting merged PR #2156 into main
🤖 @patchback |
tremble
added
backport-8
Backport to stable-8: 💚 backport PR created✅ Backport PR branch: Backported as #2240 🤖 @patchback |
SUMMARY Refer: https://issues.redhat.com/browse/ACA-1484 This PR updates the return block in the rds module documentation. ISSUE TYPE Docs Pull Request COMPONENT NAME ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis Reviewed-by: Mike Graves <[email protected]> Reviewed-by: Helen Bailey <[email protected]> (cherry picked from commit 8d37698)
This is a backport of PR #2156 as merged into main (8d37698). SUMMARY Refer: https://issues.redhat.com/browse/ACA-1484 This PR updates the return block in the rds module documentation. ISSUE TYPE Docs Pull Request COMPONENT NAME ADDITIONAL INFORMATION Reviewed-by: Mark Chappell
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 Docs Pull Request COMPONENT NAME rds_snapshot_info ADDITIONAL INFORMATION The documentation for rds_snapshot_info show that the module returns cluster_snapshots, but this is only true when db_cluster_identifier or db_cluster_snapshot_identifier is defined. The module returns snapshots when db_snapshot_identifier or db_instance_identifier is 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 the snapshots object). Several fields were also missing from the return objects for both snapshots and cluster_snapshots, so those have been added. Some descriptions also varied for identical fields in snapshots and cluster_snapshots, so all descriptions have been updated to match the AWS CLI documentation pages for describe-db-snapshots and describe-db-cluster-snapshots. Reviewed-by: Alina Buzachis Reviewed-by: Mark Chappell
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 Docs Pull Request COMPONENT NAME rds_snapshot_info ADDITIONAL INFORMATION The documentation for rds_snapshot_info show that the module returns cluster_snapshots, but this is only true when db_cluster_identifier or db_cluster_snapshot_identifier is defined. The module returns snapshots when db_snapshot_identifier or db_instance_identifier is 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 the snapshots object). Several fields were also missing from the return objects for both snapshots and cluster_snapshots, so those have been added. Some descriptions also varied for identical fields in snapshots and cluster_snapshots, so all descriptions have been updated to match the AWS CLI documentation pages for describe-db-snapshots and describe-db-cluster-snapshots. Reviewed-by: Alina Buzachis Reviewed-by: Mark Chappell (cherry picked from commit 786c4b7)
This is a backport of PR #2354 as merged into main (786c4b7). 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 Docs Pull Request COMPONENT NAME rds_snapshot_info ADDITIONAL INFORMATION The documentation for rds_snapshot_info show that the module returns cluster_snapshots, but this is only true when db_cluster_identifier or db_cluster_snapshot_identifier is defined. The module returns snapshots when db_snapshot_identifier or db_instance_identifier is 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 the snapshots object). Several fields were also missing from the return objects for both snapshots and cluster_snapshots, so those have been added. Some descriptions also varied for identical fields in snapshots and cluster_snapshots, so all descriptions have been updated to match the AWS CLI documentation pages for describe-db-snapshots and describe-db-cluster-snapshots. Reviewed-by: Helen Bailey <[email protected]> Reviewed-by: Bikouo Aubin Reviewed-by: GomathiselviS <[email protected]>
SUMMARY
Refer: https://issues.redhat.com/browse/ACA-1484
This PR updates the return block in the rds module documentation.
ISSUE TYPE
COMPONENT NAME
ADDITIONAL INFORMATION