External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-03-10 22:19:28 -02:30
Code Issues Packages Projects Releases Wiki Activity

Fix documentation in api lookup plugin, fix typos in integration tests

Browse Source
This commit is contained in:
beeankha
2020-06-09 13:45:45 -04:00
committed by John Westcott IV
parent 96ae3268a5
commit 6715ea493f
4 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
awx_collection/plugins/lookup/tower_api.py
View File

@@ -8,16 +8,16 @@ lookup: tower_api
author: John Westcott IV (@john-westcott-iv) author: John Westcott IV (@john-westcott-iv)
short_description: Search the API for objects short_description: Search the API for objects
requirements: requirements:
- None - None
description: description:
- Returns GET requests to the Ansible Tower API. See - Returns GET requests from the Ansible Tower API. See
U(https://docs.ansible.com/ansible-tower/latest/html/towerapi/index.html) for API usage. U(https://docs.ansible.com/ansible-tower/latest/html/towerapi/index.html) for API usage.
extends_documentation_fragment: extends_documentation_fragment:
- awx.awx.auth_plugin - awx.awx.auth_plugin
options: options:
_terms: _terms:
description: description:
- The endpoint to query. i.e. teams, users, tokens, job_templates, etc - The endpoint to query, i.e. teams, users, tokens, job_templates, etc.
required: True required: True
query_params: query_params:
description: description:
@@ -26,8 +26,9 @@ options:
required: True required: True
get_all: get_all:
description: description:
- If the resulting query is pagenated, retriest all pages - If the resulting query is paginated, return all pages.
- note: If the query is not filtered properly this can cause a performance impact - note: If the query is not filtered properly this can cause a performance impact.
- note: In addition, the built in threshold is 10,000 items; if the query returns more an exception will be thrown.
type: boolean type: boolean
default: False default: False
""" """
@@ -65,6 +66,7 @@ from ansible.module_utils._text import to_native
from ansible.utils.display import Display from ansible.utils.display import Display
from ..module_utils.tower_api import TowerModule from ..module_utils.tower_api import TowerModule
class LookupModule(LookupBase): class LookupModule(LookupBase):
display = Display() display = Display()

1
awx_collection/plugins/lookup/tower_get_id.py
View File

@@ -46,6 +46,7 @@ from ansible.module_utils._text import to_native
from ansible.utils.display import Display from ansible.utils.display import Display
from ..module_utils.tower_api import TowerModule from ..module_utils.tower_api import TowerModule
class LookupModule(LookupBase): class LookupModule(LookupBase):
display = Display() display = Display()

2
awx_collection/tests/integration/targets/tower_lookup_api_plugin/tasks/main.yml
View File

@@ -29,7 +29,7 @@
- assert: - assert:
that: that:
- result is failed - result is failed
- "'ou must pass exactly one endpoint to query' in result.msg" - "'You must pass exactly one endpoint to query' in result.msg"
- name: Try to load invalid endpoint - name: Try to load invalid endpoint
set_fact: set_fact:

2
awx_collection/tests/integration/targets/tower_lookup_get_id_plugin/tasks/main.yml
View File

@@ -29,7 +29,7 @@
- assert: - assert:
that: that:
- result is failed - result is failed
- "'ou must pass exactly one endpoint to query' in result.msg" - "'You must pass exactly one endpoint to query' in result.msg"
- name: Try to load invalid endpoint - name: Try to load invalid endpoint
debug: debug: