a-c-m
/
ansible.utils
mirror of https://github.com/ansible-collections/ansible.utils.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update validate docs

pull/20/head
Ganesh B Nalawade 2020-10-29 11:09:11 +05:30
parent cf5e033556
commit 18a6432362
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/ansible.utils.jsonschema_validate.rst
View File

@ -5,7 +5,7 @@
ansible.utils.jsonschema
************************
**Define configurable options for jsonschema validate plugin**
**Define configurable options for jsonschema validate sub-plugin (engine).**
Version added: 1.0.0
@ -17,7 +17,7 @@ Version added: 1.0.0
Synopsis
--------
- This plugin documentation provides the configurable options that can be passed to the validate plugins when *ansible.utils.json* is used as a value for engine option.
- This plugin documentation provides the configurable options when *ansible.utils.jsonschema* is used as a value for ``engine`` option within ``validate`` plugins. Refer individual ``validate`` plugin docs ``engine`` option for more details.
@ -67,6 +67,7 @@ Notes
-----
.. note::
- This sub-plugin is not a standalone pluign and works only when used with ``validate`` plugins. This plugin will be used when ``engine`` option of ``validate`` plugin is set to *ansible.utils.jsonschema*.
- The value of ``data`` option should be either of type *dict* or *strings* which should be a valid *dict* when read in python.
- The value of ``criteria`` should be *list* of *dict* or *list* of *strings* and each *string* within the *list* entry should be a valid *dict* when read in python.