mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-01 05:49:09 -07:00
l*.py: normalize docs (#9390)
This commit is contained in:
parent
6b7ea3443d
commit
cea6eeef37
25 changed files with 1194 additions and 1350 deletions
|
@ -9,74 +9,73 @@ from __future__ import absolute_import, division, print_function
|
|||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: librato_annotation
|
||||
short_description: Create an annotation in librato
|
||||
description:
|
||||
- Create an annotation event on the given annotation stream :name. If the annotation stream does not exist, it will be created automatically
|
||||
- Create an annotation event on the given annotation stream :name. If the annotation stream does not exist, it will be created automatically.
|
||||
author: "Seth Edwards (@Sedward)"
|
||||
requirements: []
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
user:
|
||||
type: str
|
||||
description:
|
||||
- Librato account username
|
||||
required: true
|
||||
api_key:
|
||||
type: str
|
||||
description:
|
||||
- Librato account api key
|
||||
required: true
|
||||
name:
|
||||
type: str
|
||||
description:
|
||||
- The annotation stream name
|
||||
- If the annotation stream does not exist, it will be created automatically
|
||||
required: false
|
||||
title:
|
||||
type: str
|
||||
description:
|
||||
- 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
|
||||
required: true
|
||||
source:
|
||||
type: str
|
||||
description:
|
||||
- A string which describes the originating source of an annotation when that annotation is tracked across multiple members of a population
|
||||
required: false
|
||||
user:
|
||||
type: str
|
||||
description:
|
||||
type: str
|
||||
description:
|
||||
- The description contains extra metadata about a particular annotation
|
||||
- The description should contain specifics on the individual annotation e.g. Deployed 9b562b2 shipped new feature foo!
|
||||
required: false
|
||||
start_time:
|
||||
type: int
|
||||
description:
|
||||
- The unix timestamp indicating the time at which the event referenced by this annotation started
|
||||
required: false
|
||||
end_time:
|
||||
type: int
|
||||
description:
|
||||
- The unix timestamp indicating 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
|
||||
required: false
|
||||
links:
|
||||
type: list
|
||||
elements: dict
|
||||
description:
|
||||
- See examples
|
||||
'''
|
||||
- Librato account username.
|
||||
required: true
|
||||
api_key:
|
||||
type: str
|
||||
description:
|
||||
- Librato account api key.
|
||||
required: true
|
||||
name:
|
||||
type: str
|
||||
description:
|
||||
- The annotation stream name.
|
||||
- If the annotation stream does not exist, it will be created automatically.
|
||||
required: false
|
||||
title:
|
||||
type: str
|
||||
description:
|
||||
- The title of an annotation is a string and may contain spaces.
|
||||
- The title should be a short, high-level summary of the annotation for example V(v45 Deployment).
|
||||
required: true
|
||||
source:
|
||||
type: str
|
||||
description:
|
||||
- A string which describes the originating source of an annotation when that annotation is tracked across multiple members of a population.
|
||||
required: false
|
||||
description:
|
||||
type: str
|
||||
description:
|
||||
- The description contains extra metadata about a particular annotation.
|
||||
- The description should contain specifics on the individual annotation for example V(Deployed 9b562b2 shipped new feature foo!).
|
||||
required: false
|
||||
start_time:
|
||||
type: int
|
||||
description:
|
||||
- The unix timestamp indicating the time at which the event referenced by this annotation started.
|
||||
required: false
|
||||
end_time:
|
||||
type: int
|
||||
description:
|
||||
- The unix timestamp indicating 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.
|
||||
required: false
|
||||
links:
|
||||
type: list
|
||||
elements: dict
|
||||
description:
|
||||
- See examples.
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Create a simple annotation event with a source
|
||||
community.general.librato_annotation:
|
||||
user: user@example.com
|
||||
|
@ -105,7 +104,7 @@ EXAMPLES = '''
|
|||
description: This is a detailed description of maintenance
|
||||
start_time: 1395940006
|
||||
end_time: 1395954406
|
||||
'''
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.urls import fetch_url
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue