Uploaded image for project: 'Ansible Automation Platform RFEs'
  1. Ansible Automation Platform RFEs
  2. AAPRFE-2631

Module documentation should be updated to reference the REST API for users to obtain additional information

XMLWordPrintable

    • Icon: Feature Request Feature Request
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • 2.6
    • certified-content
    • False
    • Hide

      None

      Show
      None
    • False

      Currently, the documentation around developing against AAP to be poor, mainly due to the 'private/hidden' nature of the official modules.
      For example the the "group name" for the ansible.controller module had to be guessed as the project's source code (meta/runtime.yml) file was not available for review. This was for using "module_defaults". I expect to have similar issues with other modules.

      Below are the platform and controller module documentations:

      https://console.redhat.com/ansible/automation-hub/repo/published/ansible/platform/content/module/settings/

      https://console.redhat.com/ansible/automation-hub/repo/published/ansible/controller/content/module/settings/

      Lists values for the Settings modules, but documentation for the actual "settings" setting of these modules just says:
      settings (dictionary / required) A data structure to be sent into the settings endpoint

      There are some examples in the URLs above of some of the Settings modules "settings" entries, but not a full list.
      To get a full list we can open up the REST API from AAP instance, and this will list all of the values:
      https://<YOUR AAP URL>/api/controller/v2/settings/all/
      https://<YOUR AAP URL>/api/gateway/v1/settings/all/

      Referring to the API to find the required information is not mentioned in the module documentation, and it should be include in our documentation.
      So, it would be good to update the documentation for modules, so that users know to refer to the REST API for further information.
      Also, the issue is not specific to just the settings module of the above collections, there are issues with other modules as well. For example, 'authenticator' and 'authenticator_map' as well. Overall quality needs an uplift please.

              dmendoza@redhat.com Dafne Mendoza
              rhn-support-seokim kevin kim
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: