Documentation fixes + add missing license header
This commit is contained in:
parent
cb97599a97
commit
c24d4acb2a
1 changed files with 22 additions and 24 deletions
|
@ -1,4 +1,24 @@
|
||||||
#!/usr/bin/python
|
#!/usr/bin/python
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
#
|
||||||
|
# (C) Seth Edwards, 2014
|
||||||
|
#
|
||||||
|
# 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/>.
|
||||||
|
#
|
||||||
|
|
||||||
|
|
||||||
import base64
|
import base64
|
||||||
|
|
||||||
|
@ -18,64 +38,42 @@ options:
|
||||||
description:
|
description:
|
||||||
- Librato account username
|
- Librato account username
|
||||||
required: true
|
required: true
|
||||||
default: null
|
|
||||||
aliases: []
|
|
||||||
api_key:
|
api_key:
|
||||||
description:
|
description:
|
||||||
- Librato account api key
|
- Librato account api key
|
||||||
required: true
|
required: true
|
||||||
default: null
|
|
||||||
aliases: []
|
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- The annotation stream name
|
- The annotation stream name
|
||||||
- If the annotation stream does not exist, it will be created automatically
|
- If the annotation stream does not exist, it will be created automatically
|
||||||
required: false
|
required: false
|
||||||
default: null
|
|
||||||
aliases: []
|
|
||||||
title:
|
title:
|
||||||
description:
|
description:
|
||||||
- The title of an annotation is a string and may contain spaces
|
- The title of an annotation is a string and may contain spaces
|
||||||
- The title should be a short, high-level summary of the annotation e.g. v45 Deployment
|
- The title should be a short, high-level summary of the annotation e.g. v45 Deployment
|
||||||
required: true
|
required: true
|
||||||
default: null
|
|
||||||
aliases: []
|
|
||||||
source:
|
source:
|
||||||
description:
|
description:
|
||||||
- A string which describes the originating source of an annotation when that annotation is tracked across multiple members of a population
|
- A string which describes the originating source of an annotation when that annotation is tracked across multiple members of a population
|
||||||
required: false
|
required: false
|
||||||
default: null
|
|
||||||
aliases: []
|
|
||||||
description:
|
description:
|
||||||
description:
|
description:
|
||||||
- The description contains extra meta-data about a particular annotation
|
- The description contains extra meta-data about a particular annotation
|
||||||
- The description should contain specifics on the individual annotation e.g. Deployed 9b562b2: shipped new feature foo!
|
- The description should contain specifics on the individual annotation e.g. Deployed 9b562b2: shipped new feature foo!
|
||||||
required: false
|
required: false
|
||||||
default: null
|
|
||||||
aliases: []
|
|
||||||
start_time:
|
start_time:
|
||||||
description:
|
description:
|
||||||
- The unix timestamp indicating the the time at which the event referenced by this annotation started
|
- The unix timestamp indicating the the time at which the event referenced by this annotation started
|
||||||
required: false
|
required: false
|
||||||
default: "the current time"
|
|
||||||
aliases: []
|
|
||||||
end_time:
|
end_time:
|
||||||
description:
|
description:
|
||||||
- The unix timestamp indicating the the time at which the event referenced by this annotation ended
|
- The unix timestamp indicating the the time at which the event referenced by this annotation ended
|
||||||
- For events that have a duration, this is a useful way to annotate the duration of the event
|
- For events that have a duration, this is a useful way to annotate the duration of the event
|
||||||
required: false
|
required: false
|
||||||
default: null
|
|
||||||
aliases: []
|
|
||||||
links:
|
links:
|
||||||
description:
|
description:
|
||||||
- Words go here
|
- See examples
|
||||||
- that describe
|
required: true
|
||||||
- this option
|
|
||||||
required: true or false
|
|
||||||
default: a string or the word null
|
|
||||||
aliases: []
|
|
||||||
|
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
Loading…
Reference in a new issue