Skip to content
Snippets Groups Projects
Select Git revision
0 results

ipauser.py

Blame
    • Thomas Woerner's avatar
      58c936a1
      ipauser: Fix documentation sections and agument spec · 58c936a1
      Thomas Woerner authored
      ansible-test with ansible-2.14 is adding a lot of new tests to ensure
      that the documentation section and the agument spec is complete. Needed
      changes:
      
      DOCUMENTATION section
      
      - `type: str` needs to be set for string parameters
      - `type: list` needs to be set for list parameters
      - `elements: str` needs to be given for list of string parameters
      - `elements: dict` needs to be given for list of dict parameters
      - `aliases` tag needs to match `argument_spec`
      - `author` needs to be given with the github user also: `Name (@user)`
      
      RETURN section
      
      - `contains` needs to be used instead of `options` for dicts
      - `type: str` needs to be used for string parameters
      
      argument_spec
      
      - `elements="str"` needs to be added to all list of string parameters
      - `no_log=False` or `no_log=True` needs to be set for all parameters
        that have `password` in the name
      
      The `copyright` date is extended with `-2022`.
      
      Note:
      The alias "login" was used for "users" instead of "users"->"name".
      "login" is an alias for "name" if "users" is not used.
      58c936a1
      History
      ipauser: Fix documentation sections and agument spec
      Thomas Woerner authored
      ansible-test with ansible-2.14 is adding a lot of new tests to ensure
      that the documentation section and the agument spec is complete. Needed
      changes:
      
      DOCUMENTATION section
      
      - `type: str` needs to be set for string parameters
      - `type: list` needs to be set for list parameters
      - `elements: str` needs to be given for list of string parameters
      - `elements: dict` needs to be given for list of dict parameters
      - `aliases` tag needs to match `argument_spec`
      - `author` needs to be given with the github user also: `Name (@user)`
      
      RETURN section
      
      - `contains` needs to be used instead of `options` for dicts
      - `type: str` needs to be used for string parameters
      
      argument_spec
      
      - `elements="str"` needs to be added to all list of string parameters
      - `no_log=False` or `no_log=True` needs to be set for all parameters
        that have `password` in the name
      
      The `copyright` date is extended with `-2022`.
      
      Note:
      The alias "login" was used for "users" instead of "users"->"name".
      "login" is an alias for "name" if "users" is not used.