summaryrefslogtreecommitdiff
path: root/lib/ansible/modules/notification
diff options
context:
space:
mode:
authorToshio Kuratomi <a.badger@gmail.com>2017-03-14 09:07:22 -0700
committerGitHub <noreply@github.com>2017-03-14 09:07:22 -0700
commiteb1214baad0cbe2c4b7304caebb9ae1c7dc0d8db (patch)
tree5dbfed38c583a78e5f959aa11fb902d9994c889a /lib/ansible/modules/notification
parent2be3418a8150ab1099e23e613919a7337e13934f (diff)
downloadansible-eb1214baad0cbe2c4b7304caebb9ae1c7dc0d8db.tar.gz
New metadata 1.0 (#22587)
Changes to the metadata format were approved here: https://github.com/ansible/proposals/issues/54 * Update documentation to the new metadata format * Changes to metadata-tool to account for new metadata * Add GPL license header * Add upgrade subcommand to upgrade metadata version * Change default metadata to the new format * Fix exclusion of non-modules from the metadata report * Fix ansible-doc for new module metadata * Exclude metadata version from ansible-doc output * Fix website docs generation for the new metadata * Update metadata schema in valiate-modules test * Update the metadata in all modules to the new version
Diffstat (limited to 'lib/ansible/modules/notification')
-rw-r--r--lib/ansible/modules/notification/campfire.py7
-rw-r--r--lib/ansible/modules/notification/cisco_spark.py9
-rw-r--r--lib/ansible/modules/notification/flowdock.py7
-rw-r--r--lib/ansible/modules/notification/grove.py7
-rw-r--r--lib/ansible/modules/notification/hall.py7
-rw-r--r--lib/ansible/modules/notification/hipchat.py7
-rw-r--r--lib/ansible/modules/notification/irc.py7
-rw-r--r--lib/ansible/modules/notification/jabber.py7
-rw-r--r--lib/ansible/modules/notification/mail.py7
-rw-r--r--lib/ansible/modules/notification/mattermost.py7
-rw-r--r--lib/ansible/modules/notification/mqtt.py7
-rw-r--r--lib/ansible/modules/notification/nexmo.py7
-rw-r--r--lib/ansible/modules/notification/osx_say.py7
-rw-r--r--lib/ansible/modules/notification/pushbullet.py7
-rw-r--r--lib/ansible/modules/notification/pushover.py7
-rw-r--r--lib/ansible/modules/notification/rocketchat.py7
-rw-r--r--lib/ansible/modules/notification/sendgrid.py7
-rw-r--r--lib/ansible/modules/notification/slack.py7
-rw-r--r--lib/ansible/modules/notification/sns.py7
-rw-r--r--lib/ansible/modules/notification/telegram.py7
-rw-r--r--lib/ansible/modules/notification/twilio.py7
-rw-r--r--lib/ansible/modules/notification/typetalk.py7
22 files changed, 88 insertions, 68 deletions
diff --git a/lib/ansible/modules/notification/campfire.py b/lib/ansible/modules/notification/campfire.py
index 8a7b44355f..bb8bd84497 100644
--- a/lib/ansible/modules/notification/campfire.py
+++ b/lib/ansible/modules/notification/campfire.py
@@ -15,9 +15,10 @@
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-ANSIBLE_METADATA = {'status': ['preview'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['preview'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = '''
---
diff --git a/lib/ansible/modules/notification/cisco_spark.py b/lib/ansible/modules/notification/cisco_spark.py
index fa3245934e..189c94a62b 100644
--- a/lib/ansible/modules/notification/cisco_spark.py
+++ b/lib/ansible/modules/notification/cisco_spark.py
@@ -17,11 +17,10 @@
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-ANSIBLE_METADATA = {
- 'status': ['stableinterface'],
- 'supported_by': 'community',
- 'version': '1.0'
-}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['stableinterface'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = '''
---
diff --git a/lib/ansible/modules/notification/flowdock.py b/lib/ansible/modules/notification/flowdock.py
index 08049c05bc..f21af4680a 100644
--- a/lib/ansible/modules/notification/flowdock.py
+++ b/lib/ansible/modules/notification/flowdock.py
@@ -18,9 +18,10 @@
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-ANSIBLE_METADATA = {'status': ['preview'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['preview'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = '''
---
diff --git a/lib/ansible/modules/notification/grove.py b/lib/ansible/modules/notification/grove.py
index 593b8def1f..eeedc8b5ba 100644
--- a/lib/ansible/modules/notification/grove.py
+++ b/lib/ansible/modules/notification/grove.py
@@ -16,9 +16,10 @@
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-ANSIBLE_METADATA = {'status': ['preview'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['preview'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = '''
---
diff --git a/lib/ansible/modules/notification/hall.py b/lib/ansible/modules/notification/hall.py
index 610417b745..2ec1ea1a88 100644
--- a/lib/ansible/modules/notification/hall.py
+++ b/lib/ansible/modules/notification/hall.py
@@ -19,9 +19,10 @@
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-ANSIBLE_METADATA = {'status': ['preview'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['preview'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = """
module: hall
diff --git a/lib/ansible/modules/notification/hipchat.py b/lib/ansible/modules/notification/hipchat.py
index d7dab87929..d9efef8776 100644
--- a/lib/ansible/modules/notification/hipchat.py
+++ b/lib/ansible/modules/notification/hipchat.py
@@ -15,9 +15,10 @@
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-ANSIBLE_METADATA = {'status': ['stableinterface'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['stableinterface'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = '''
---
diff --git a/lib/ansible/modules/notification/irc.py b/lib/ansible/modules/notification/irc.py
index d36b4c5de0..2082f70977 100644
--- a/lib/ansible/modules/notification/irc.py
+++ b/lib/ansible/modules/notification/irc.py
@@ -19,9 +19,10 @@
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
#
-ANSIBLE_METADATA = {'status': ['stableinterface'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['stableinterface'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = '''
---
diff --git a/lib/ansible/modules/notification/jabber.py b/lib/ansible/modules/notification/jabber.py
index 8c374faf9c..e7c94545d3 100644
--- a/lib/ansible/modules/notification/jabber.py
+++ b/lib/ansible/modules/notification/jabber.py
@@ -19,9 +19,10 @@
# along with Ansible. If not, see <http://www.gnu.org/licenses/>
-ANSIBLE_METADATA = {'status': ['stableinterface'],
- 'supported_by': 'committer',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['stableinterface'],
+ 'supported_by': 'curated'}
+
DOCUMENTATION = '''
---
diff --git a/lib/ansible/modules/notification/mail.py b/lib/ansible/modules/notification/mail.py
index d1b5f9994e..95f96afa15 100644
--- a/lib/ansible/modules/notification/mail.py
+++ b/lib/ansible/modules/notification/mail.py
@@ -18,9 +18,10 @@
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-ANSIBLE_METADATA = {'status': ['stableinterface'],
- 'supported_by': 'committer',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['stableinterface'],
+ 'supported_by': 'curated'}
+
DOCUMENTATION = '''
---
diff --git a/lib/ansible/modules/notification/mattermost.py b/lib/ansible/modules/notification/mattermost.py
index feba1fb9cb..e6d30f482d 100644
--- a/lib/ansible/modules/notification/mattermost.py
+++ b/lib/ansible/modules/notification/mattermost.py
@@ -23,9 +23,10 @@
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-ANSIBLE_METADATA = {'status': ['preview'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['preview'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = """
module: mattermost
diff --git a/lib/ansible/modules/notification/mqtt.py b/lib/ansible/modules/notification/mqtt.py
index 201834fbf6..aefa714478 100644
--- a/lib/ansible/modules/notification/mqtt.py
+++ b/lib/ansible/modules/notification/mqtt.py
@@ -19,9 +19,10 @@
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
#
-ANSIBLE_METADATA = {'status': ['preview'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['preview'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = '''
---
diff --git a/lib/ansible/modules/notification/nexmo.py b/lib/ansible/modules/notification/nexmo.py
index 0d646935ae..15a7f5347c 100644
--- a/lib/ansible/modules/notification/nexmo.py
+++ b/lib/ansible/modules/notification/nexmo.py
@@ -18,9 +18,10 @@
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-ANSIBLE_METADATA = {'status': ['preview'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['preview'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = """
module: nexmo
diff --git a/lib/ansible/modules/notification/osx_say.py b/lib/ansible/modules/notification/osx_say.py
index 4d05629114..d1eb71ae25 100644
--- a/lib/ansible/modules/notification/osx_say.py
+++ b/lib/ansible/modules/notification/osx_say.py
@@ -18,9 +18,10 @@
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-ANSIBLE_METADATA = {'status': ['stableinterface'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['stableinterface'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = '''
---
diff --git a/lib/ansible/modules/notification/pushbullet.py b/lib/ansible/modules/notification/pushbullet.py
index 6a1151b8ba..216eab72d2 100644
--- a/lib/ansible/modules/notification/pushbullet.py
+++ b/lib/ansible/modules/notification/pushbullet.py
@@ -16,9 +16,10 @@
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-ANSIBLE_METADATA = {'status': ['preview'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['preview'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = '''
---
diff --git a/lib/ansible/modules/notification/pushover.py b/lib/ansible/modules/notification/pushover.py
index 3d2239c1ce..37093127c6 100644
--- a/lib/ansible/modules/notification/pushover.py
+++ b/lib/ansible/modules/notification/pushover.py
@@ -20,9 +20,10 @@
###
-ANSIBLE_METADATA = {'status': ['preview'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['preview'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = '''
---
diff --git a/lib/ansible/modules/notification/rocketchat.py b/lib/ansible/modules/notification/rocketchat.py
index 035799efdd..1675c73ca4 100644
--- a/lib/ansible/modules/notification/rocketchat.py
+++ b/lib/ansible/modules/notification/rocketchat.py
@@ -20,9 +20,10 @@
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-ANSIBLE_METADATA = {'status': ['preview'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['preview'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = """
module: rocketchat
diff --git a/lib/ansible/modules/notification/sendgrid.py b/lib/ansible/modules/notification/sendgrid.py
index 260a351d14..b76ea75f5b 100644
--- a/lib/ansible/modules/notification/sendgrid.py
+++ b/lib/ansible/modules/notification/sendgrid.py
@@ -18,9 +18,10 @@
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-ANSIBLE_METADATA = {'status': ['preview'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['preview'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = '''
---
diff --git a/lib/ansible/modules/notification/slack.py b/lib/ansible/modules/notification/slack.py
index 1a59f65bb0..6077a20057 100644
--- a/lib/ansible/modules/notification/slack.py
+++ b/lib/ansible/modules/notification/slack.py
@@ -21,9 +21,10 @@
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-ANSIBLE_METADATA = {'status': ['stableinterface'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['stableinterface'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = """
module: slack
diff --git a/lib/ansible/modules/notification/sns.py b/lib/ansible/modules/notification/sns.py
index 7348c6173a..66f4135604 100644
--- a/lib/ansible/modules/notification/sns.py
+++ b/lib/ansible/modules/notification/sns.py
@@ -18,9 +18,10 @@
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-ANSIBLE_METADATA = {'status': ['preview'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['preview'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = """
module: sns
diff --git a/lib/ansible/modules/notification/telegram.py b/lib/ansible/modules/notification/telegram.py
index d940b8166f..caa405fbdf 100644
--- a/lib/ansible/modules/notification/telegram.py
+++ b/lib/ansible/modules/notification/telegram.py
@@ -20,9 +20,10 @@
#
-ANSIBLE_METADATA = {'status': ['preview'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['preview'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = """
diff --git a/lib/ansible/modules/notification/twilio.py b/lib/ansible/modules/notification/twilio.py
index 9325ed7045..9d42168ed6 100644
--- a/lib/ansible/modules/notification/twilio.py
+++ b/lib/ansible/modules/notification/twilio.py
@@ -18,9 +18,10 @@
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-ANSIBLE_METADATA = {'status': ['preview'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['preview'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = '''
---
diff --git a/lib/ansible/modules/notification/typetalk.py b/lib/ansible/modules/notification/typetalk.py
index f638be09ab..562c504a65 100644
--- a/lib/ansible/modules/notification/typetalk.py
+++ b/lib/ansible/modules/notification/typetalk.py
@@ -15,9 +15,10 @@
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-ANSIBLE_METADATA = {'status': ['preview'],
- 'supported_by': 'community',
- 'version': '1.0'}
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+ 'status': ['preview'],
+ 'supported_by': 'community'}
+
DOCUMENTATION = '''
---