Debian Codegraph @

src/ansiblelint/schemas/role-arg-spec.json

raw
1 {
2 "$defs": {
3 "attribute": {
4 "additionalProperties": false,
5 "properties": {
6 "description": {
7 "description": "Detailed explanation of what this attribute does. It should be written in full sentences.",
8 "oneOf": [
9 {
10 "type": "string"
11 },
12 {
13 "items": {
14 "type": "string"
15 },
16 "type": "array"
17 }
18 ]
19 },
20 "details": {
21 "description": "Detailed explanation of what this attribute does. It should be written in full sentences.",
22 "oneOf": [
23 {
24 "type": "string"
25 },
26 {
27 "items": {
28 "type": "string"
29 },
30 "type": "array"
31 }
32 ]
33 },
34 "membership": {
35 "oneOf": [
36 {
37 "type": "string"
38 },
39 {
40 "items": {
41 "type": "string"
42 },
43 "type": "array"
44 }
45 ]
46 },
47 "platform": {
48 "oneOf": [
49 {
50 "type": "string"
51 },
52 {
53 "items": {
54 "type": "string"
55 },
56 "type": "array"
57 }
58 ]
59 },
60 "support": {
61 "enum": ["full", "partial", "none", "N/A"],
62 "type": "string"
63 },
64 "version_added": {
65 "type": "string"
66 }
67 },
68 "required": ["description", "support"],
69 "title": "Attribute"
70 },
71 "datatype": {
72 "enum": [
73 "str",
74 "list",
75 "dict",
76 "bool",
77 "int",
78 "float",
79 "path",
80 "raw",
81 "jsonarg",
82 "json",
83 "bytes",
84 "bits"
85 ],
86 "type": "string"
87 },
88 "deprecated_alias": {
89 "properties": {
90 "collection_name": {
91 "type": "string"
92 },
93 "date": {
94 "type": "string"
95 },
96 "name": {
97 "type": "string"
98 },
99 "version": {
100 "type": "string"
101 }
102 },
103 "required": ["name"],
104 "type": "object"
105 },
106 "entry_point": {
107 "additionalProperties": false,
108 "properties": {
109 "attributes": {
110 "additionalProperties": {
111 "$ref": "#/$defs/attribute"
112 },
113 "type": "object"
114 },
115 "author": {
116 "oneOf": [
117 {
118 "type": "string"
119 },
120 {
121 "items": {
122 "type": "string"
123 },
124 "type": "array"
125 }
126 ]
127 },
128 "description": {
129 "oneOf": [
130 {
131 "type": "string"
132 },
133 {
134 "items": {
135 "type": "string"
136 },
137 "type": "array"
138 }
139 ]
140 },
141 "examples": {
142 "type": "string"
143 },
144 "options": {
145 "additionalProperties": {
146 "$ref": "#/$defs/option"
147 },
148 "type": "object"
149 },
150 "seealso": {
151 "items": {
152 "oneOf": [
153 {
154 "additionalProperties": false,
155 "properties": {
156 "description": {
157 "type": "string"
158 },
159 "module": {
160 "type": "string"
161 }
162 },
163 "required": ["module"],
164 "type": "object"
165 },
166 {
167 "additionalProperties": false,
168 "properties": {
169 "description": {
170 "type": "string"
171 },
172 "plugin": {
173 "type": "string"
174 },
175 "plugin_type": {
176 "type": "string"
177 }
178 },
179 "required": ["plugin", "plugin_type"],
180 "type": "object"
181 },
182 {
183 "additionalProperties": false,
184 "properties": {
185 "description": {
186 "type": "string"
187 },
188 "ref": {
189 "type": "string"
190 }
191 },
192 "required": ["description", "ref"],
193 "type": "object"
194 },
195 {
196 "additionalProperties": false,
197 "properties": {
198 "description": {
199 "type": "string"
200 },
201 "link": {
202 "type": "string"
203 },
204 "name": {
205 "type": "string"
206 }
207 },
208 "required": ["description", "link", "name"],
209 "type": "object"
210 }
211 ]
212 },
213 "type": "array"
214 },
215 "short_description": {
216 "type": "string"
217 },
218 "version_added": {
219 "type": "string"
220 }
221 },
222 "title": "Entry Point",
223 "type": "object"
224 },
225 "full-jinja": {
226 "pattern": "^\\{[\\{%](.|[\r\n])*[\\}%]\\}$",
227 "type": "string"
228 },
229 "option": {
230 "additionalProperties": false,
231 "markdownDescription": "See [argument-spec](https://docs.ansible.com/projects/ansible/latest/dev_guide/developing_program_flow_modules.html#argument-spec)",
232 "properties": {
233 "apply_defaults": {
234 "type": "string"
235 },
236 "choices": {
237 "oneOf": [
238 {
239 "type": "array"
240 },
241 {
242 "$ref": "#/$defs/full-jinja",
243 "type": "string"
244 }
245 ]
246 },
247 "default": {
248 "default": "None"
249 },
250 "description": {
251 "description": "Detailed explanation of what this option does. It should be written in full sentences.",
252 "oneOf": [
253 {
254 "type": "string"
255 },
256 {
257 "items": {
258 "type": "string"
259 },
260 "type": "array"
261 }
262 ]
263 },
264 "elements": {
265 "$ref": "#/$defs/datatype"
266 },
267 "fallback": {
268 "default": "None",
269 "type": "string"
270 },
271 "no_log": {
272 "default": false,
273 "type": "boolean"
274 },
275 "option-name": {
276 "description": "The name of the option/argument.",
277 "type": "string"
278 },
279 "options": {
280 "additionalProperties": {
281 "$ref": "#/$defs/option"
282 },
283 "type": "object"
284 },
285 "required": {
286 "default": false,
287 "type": "boolean"
288 },
289 "mutually_exclusive": {
290 "type": "array",
291 "items": {
292 "items": {
293 "type": "string"
294 }
295 }
296 },
297 "required_together": {
298 "type": "array",
299 "items": {
300 "type": "array",
301 "items": {
302 "type": "string"
303 }
304 }
305 },
306 "required_one_of": {
307 "type": "array",
308 "items": {
309 "items": {
310 "type": "string"
311 }
312 }
313 },
314 "required_if": {
315 "type": "array",
316 "items": {
317 "type": "array",
318 "prefixItems": [
319 {
320 "type": "string"
321 },
322 {},
323 {
324 "type": "array",
325 "items": {
326 "type": "string"
327 }
328 },
329 {
330 "type": "boolean"
331 }
332 ],
333 "minItems": 3,
334 "maxItems": 4
335 }
336 },
337 "required_by": {
338 "type": "object",
339 "additionalProperties": {
340 "oneOf": [
341 {
342 "type": "string"
343 },
344 {
345 "type": "array",
346 "items": {
347 "type": "string"
348 }
349 }
350 ]
351 }
352 },
353 "type": {
354 "$ref": "#/$defs/datatype",
355 "markdownDescription": "See [argument-spec](https://docs.ansible.com/projects/ansible/latest/dev_guide/developing_program_flow_modules.html#argument-spec"
356 },
357 "version_added": {
358 "type": "string"
359 }
360 },
361 "removed_at_date": {
362 "type": "string"
363 },
364 "removed_from_collection": {
365 "type": "string"
366 },
367 "removed_in_version": {
368 "type": "string"
369 },
370 "title": "Option"
371 }
372 },
373 "$id": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/role-arg-spec.json",
374 "$schema": "http://json-schema.org/draft-07/schema",
375 "additionalProperties": false,
376 "examples": ["meta/argument_specs.yml"],
377 "markdownDescription": "See [role-argument-validation](https://docs.ansible.com/projects/ansible/latest/user_guide/playbooks_reuse_roles.html#role-argument-validation)",
378 "properties": {
379 "argument_specs": {
380 "additionalProperties": {
381 "$ref": "#/$defs/entry_point"
382 },
383 "markdownDescription": "Add entry point, usually `main`.\nSee [role-argument-validation](https://docs.ansible.com/projects/ansible/latest/user_guide/playbooks_reuse_roles.html#role-argument-validation)"
384 }
385 },
386 "title": "Ansible Role Argument Specs Schema"
387 }