Skip to content
Snippets Groups Projects
Select Git revision
  • master default protected
  • v1.14.6
  • v1.14.5
  • v1.14.4
  • v1.14.3
  • v1.14.2
  • v1.14.1
  • v1.14.0
  • v1.13.2
  • v1.13.1
  • v1.13.0
  • v1.12.1
  • v1.12.0
  • v1.11.1
  • v1.11.0
  • v1.10.0
  • v1.9.2
  • v1.9.1
  • v1.9.0
  • v1.8.4
  • v1.8.3
21 results

ipavault.py

  • Thomas Woerner's avatar
    2621b311
    ipavault: Fix documentation sections and agument spec · 2621b311
    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: bool` needs to be set for bool parameters
    
    - `type: list` needs to be set for list parameters
    - `elements: str` needs to be given for list of string parameters
    - `type: string` is not valid and needs to be replaced by `type: str`
    - `required` tags need to be fixed according to the `argument_spec`
    - `aliases` tag needs to match `argument_spec`
    - `author` needs to be given with the github user also: `Name (@user)`
    - `choices` needs to match `argument_spec`
    - all parameters need to be defined
    
    RETURN section
    
    - `contains` needs to be used instead of `options` for dicts
    - `type: string` is not valid and needs to be replaced by `type: str`
    
    argument_spec
    
    - `elements="str"` needs to be added to all list of string parameters
    - `default=.*` needs to be dropped if `required=True` is also given
    
    The `copyright` date is extended with `-2022`.
    2621b311
    History
    ipavault: 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: bool` needs to be set for bool parameters
    
    - `type: list` needs to be set for list parameters
    - `elements: str` needs to be given for list of string parameters
    - `type: string` is not valid and needs to be replaced by `type: str`
    - `required` tags need to be fixed according to the `argument_spec`
    - `aliases` tag needs to match `argument_spec`
    - `author` needs to be given with the github user also: `Name (@user)`
    - `choices` needs to match `argument_spec`
    - all parameters need to be defined
    
    RETURN section
    
    - `contains` needs to be used instead of `options` for dicts
    - `type: string` is not valid and needs to be replaced by `type: str`
    
    argument_spec
    
    - `elements="str"` needs to be added to all list of string parameters
    - `default=.*` needs to be dropped if `required=True` is also given
    
    The `copyright` date is extended with `-2022`.