diff --git a/docs/ansible.utils.jsonschema_validate.rst b/docs/ansible.utils.jsonschema_validate.rst new file mode 100644 index 0000000..c3ab581 --- /dev/null +++ b/docs/ansible.utils.jsonschema_validate.rst @@ -0,0 +1,90 @@ +.. _ansible.utils.jsonschema_validate: + + +************************ +ansible.utils.jsonschema +************************ + +**Define configurable options for jsonschema validate plugin** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +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. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + +
ParameterChoices/DefaultsConfigurationComments
+
+ draft + +
+ - +
+ 		+
    Choices: +
  • draft3
    • +
  • draft4
    • +
  • draft6
    • +
  • draft7 ←
    • +
+ 		+
env:ANSIBLE_VALIDATE_JSONSCHEMA_DRAFT
+
var: ansible_validate_jsonschema_draft
+ 		+
This option provides the jsonschema specification that should be used for the validating the data. The criteria option in the validate plugin should follow the specifiaction as mentined by this option
+
+
+ + +Notes +----- + +.. note:: + - 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. + + + + + + + +Status +------ + + +Authors +~~~~~~~ + +- Ganesh Nalawade (@ganeshrn) + + +.. hint:: + Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.