Doc fragments to plugins (#50172)

* promote doc_fragments into actual plugins

  change tests hardcoded path to doc fragments
  avoid sanity in fragments
  avoid improper testing of doc_fragments
  also change runner paths
 fix botmeta
 updated comment for fragments
 updated docs
This commit is contained in:
Brian Coca 2019-01-23 20:03:47 -05:00 committed by GitHub
commit 96b3ef5553
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
106 changed files with 51 additions and 31 deletions

View file

@ -0,0 +1,47 @@
# Copyright: (c) 2018, Johannes Brunswicker <johannes.brunswicker@gmail.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
class ModuleDocFragment(object):
DOCUMENTATION = """
options:
headers:
description:
- A dictionary of additional headers to be sent to POST and PUT requests.
- Is needed for some modules
required: false
utm_host:
description:
- The REST Endpoint of the Sophos UTM.
required: true
utm_port:
description:
- The port of the REST interface.
default: 4444
utm_token:
description:
- "The token used to identify at the REST-API. See U(https://www.sophos.com/en-us/medialibrary/\
PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en), Chapter 2.4.2."
required: true
utm_protocol:
description:
- The protocol of the REST Endpoint.
choices:
- https
- http
default: https
validate_certs:
description:
- Whether the REST interface's ssl certificate should be verified or not.
default: True
type: bool
state:
description:
- The desired state of the object.
- C(present) will create or update an object
- C(absent) will delete an object if it was present
choices:
- present
- absent
default: present
"""