Skip to content

Document autoscaling_instance_refresh_info return value is a list #1609

Open
@mdavis-xyz

Description

@mdavis-xyz

Summary

The docs for the output of autoscaling_instance_refresh_info look like it returns a dictionary about the most recent refresh.

Actually it returns a list of dictionaries like that, named instance_refreshes.
We should change the documentation to make it clear that you get a list, called instance_refreshes. (e.g. how can a user read today's docs and know that it's instance_refreshes not just refreshes.)

Note that other info modules like iam_role_info say something like:

iam_roles complex | List of IAM roles

When the description says "List", that's clear.
But I don't understand why it's type "Complex".
To me that suggests it's a dictionary of dictionaries, which is not the case.
Can we make it say the type of instance_refreshes or iam_roles is "List"?

Issue Type

Documentation Report

Component Name

autoscaling_instance_refresh_info

Ansible Version

N/A

Collection Versions

N/A

Configuration

N/A

OS / Environment

N/A

Additional Information

No response

Code of Conduct

  • I agree to follow the Ansible Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions