| 1 |
{ |
| 2 |
"$schema": "http://json-schema.org/draft-07/schema", |
| 3 |
"$id": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/play-argspec.json", |
| 4 |
"title": "Ansible Playbook Argspec Schema", |
| 5 |
"description": "See https://docs.ansible.com/projects/ansible/latest/collections/ansible/builtin/validate_argument_spec_module.html", |
| 6 |
"examples": ["**/*.meta.yml", "**/*.meta.yaml"], |
| 7 |
"type": "object", |
| 8 |
"properties": { |
| 9 |
"short_description": { |
| 10 |
"type": "string", |
| 11 |
"description": "Brief description of the playbook" |
| 12 |
}, |
| 13 |
"description": { |
| 14 |
"type": "string", |
| 15 |
"description": "Detailed description of the playbook" |
| 16 |
}, |
| 17 |
"argument_specs": { |
| 18 |
"type": "object", |
| 19 |
"description": "Argument specifications for the playbook", |
| 20 |
"minProperties": 1, |
| 21 |
"patternProperties": { |
| 22 |
"^[a-zA-Z_][a-zA-Z0-9_]*$": { |
| 23 |
"type": "object", |
| 24 |
"properties": { |
| 25 |
"short_description": { |
| 26 |
"type": "string", |
| 27 |
"description": "Brief description of the argument spec" |
| 28 |
}, |
| 29 |
"description": { |
| 30 |
"type": "array", |
| 31 |
"items": { |
| 32 |
"type": "string" |
| 33 |
}, |
| 34 |
"description": "Detailed description lines" |
| 35 |
}, |
| 36 |
"author": { |
| 37 |
"type": "array", |
| 38 |
"items": { |
| 39 |
"type": "string" |
| 40 |
}, |
| 41 |
"description": "List of authors" |
| 42 |
}, |
| 43 |
"options": { |
| 44 |
"type": "object", |
| 45 |
"description": "Available options/parameters", |
| 46 |
"patternProperties": { |
| 47 |
"^[a-zA-Z_][a-zA-Z0-9_]*$": { |
| 48 |
"type": "object", |
| 49 |
"properties": { |
| 50 |
"type": { |
| 51 |
"type": "string", |
| 52 |
"enum": [ |
| 53 |
"str", |
| 54 |
"int", |
| 55 |
"bool", |
| 56 |
"float", |
| 57 |
"list", |
| 58 |
"dict", |
| 59 |
"path", |
| 60 |
"raw" |
| 61 |
], |
| 62 |
"description": "Parameter type" |
| 63 |
}, |
| 64 |
"required": { |
| 65 |
"type": "boolean", |
| 66 |
"description": "Whether the parameter is required" |
| 67 |
}, |
| 68 |
"default": { |
| 69 |
"description": "Default value for the parameter" |
| 70 |
}, |
| 71 |
"choices": { |
| 72 |
"type": "array", |
| 73 |
"description": "Valid choices for the parameter" |
| 74 |
}, |
| 75 |
"description": { |
| 76 |
"type": "string", |
| 77 |
"description": "Description of the parameter" |
| 78 |
} |
| 79 |
}, |
| 80 |
"additionalProperties": true |
| 81 |
} |
| 82 |
}, |
| 83 |
"additionalProperties": false |
| 84 |
}, |
| 85 |
"examples": { |
| 86 |
"type": "string", |
| 87 |
"description": "Usage examples in YAML format" |
| 88 |
}, |
| 89 |
"return": { |
| 90 |
"description": "Return value specification" |
| 91 |
} |
| 92 |
}, |
| 93 |
"required": ["short_description", "options", "examples"], |
| 94 |
"additionalProperties": true |
| 95 |
} |
| 96 |
}, |
| 97 |
"additionalProperties": false |
| 98 |
} |
| 99 |
}, |
| 100 |
"required": ["short_description", "description", "argument_specs"], |
| 101 |
"additionalProperties": false |
| 102 |
} |