Skip to content
Snippets Groups Projects
  • Thomas Woerner's avatar
    19758959
    ipadnszone: Fix documentation sections and agument spec · 19758959
    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
    - `suboptions` instead of `options` needs to be used for dict parameters
    - `aliases` tag needs to match `argument_spec`
    - `type` tag needs to match `argument_spec`
    - `required` tags need to be fixed according to the `argument_spec`
    - `authors` needs to be given with the github user also: `Name (@user)`
    
    RETURN section
    
    - `type: dict` needs to be given for dicts
    - `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
    - `elements="dict"` needs to be added to all list of dict parameters
    - `type=str` and `type=int` need to be replaced by `type="str"` and
      `type="int"`
    
    The `copyright` date is extended with `-2022`.
    19758959
    History
    ipadnszone: 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
    - `suboptions` instead of `options` needs to be used for dict parameters
    - `aliases` tag needs to match `argument_spec`
    - `type` tag needs to match `argument_spec`
    - `required` tags need to be fixed according to the `argument_spec`
    - `authors` needs to be given with the github user also: `Name (@user)`
    
    RETURN section
    
    - `type: dict` needs to be given for dicts
    - `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
    - `elements="dict"` needs to be added to all list of dict parameters
    - `type=str` and `type=int` need to be replaced by `type="str"` and
      `type="int"`
    
    The `copyright` date is extended with `-2022`.