From f296d74329dc61492efc6bcb26d297526e4e06b8 Mon Sep 17 00:00:00 2001 From: Jonathan Davila Date: Mon, 25 Apr 2016 12:54:11 -0400 Subject: [PATCH] Documentation fragment. To be used with modules that use basic auth. (#15582) Supplies a doc fragment for: - api_username - api_password - api_url - validate_certs --- .../utils/module_docs_fragments/auth_basic.py | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 lib/ansible/utils/module_docs_fragments/auth_basic.py diff --git a/lib/ansible/utils/module_docs_fragments/auth_basic.py b/lib/ansible/utils/module_docs_fragments/auth_basic.py new file mode 100644 index 00000000000..4150919937b --- /dev/null +++ b/lib/ansible/utils/module_docs_fragments/auth_basic.py @@ -0,0 +1,42 @@ +# 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 . + + +class ModuleDocFragment(object): + + # Standard files documentation fragment + DOCUMENTATION = """ +options: + api_url: + required: false + default: null + description: + - The resolvable endpoint for the API + api_username: + required: false + default: null + description: + - The username to use for authentication against the API + api_password: + required: false + default: null + description: + - The password to use for authentication against the API + validate_certs: + required: false + default: yes + description: + - Whether or not to validate SSL certs when supplying a https endpoint. +"""