doc_fragments: Clean up parameter types (other) (#52182)

This PR includes:
- Parameter types added
- Copyright format fixes
- Short license statement
This commit is contained in:
Dag Wieers 2019-02-19 21:23:26 +01:00 committed by Sandra McCann
parent 84ba41e0e1
commit aa83307c68
8 changed files with 93 additions and 99 deletions

View file

@ -1,36 +1,28 @@
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
# -*- coding: utf-8 -*-
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
class ModuleDocFragment(object):
# Standard files documentation fragment
DOCUMENTATION = """
DOCUMENTATION = r'''
options:
api_url:
description:
- The resolvable endpoint for the API
type: str
api_username:
description:
- The username to use for authentication against the API
type: str
api_password:
description:
- The password to use for authentication against the API
type: str
validate_certs:
description:
- Whether or not to validate SSL certs when supplying a https endpoint.
type: bool
default: 'yes'
"""
default: yes
'''