{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://catalog.lintel.tools/schemas/schemastore/ansible-meta/_shared/latest--role-arg-spec.json",
  "title": "Ansible Role Argument Specs Schema",
  "x-lintel": {
    "source": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/role-arg-spec.json",
    "sourceSha256": "8dbc2c913761f1bf738362bf0e33966317022526df625166b9923a94cbe99342"
  },
  "type": "object",
  "properties": {
    "argument_specs": {
      "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)",
      "additionalProperties": {
        "$ref": "#/$defs/entry_point"
      }
    }
  },
  "$defs": {
    "attribute": {
      "title": "Attribute",
      "properties": {
        "description": {
          "description": "Detailed explanation of what this attribute does. It should be written in full sentences.",
          "oneOf": [
            {
              "type": "string"
            },
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          ]
        },
        "details": {
          "description": "Detailed explanation of what this attribute does. It should be written in full sentences.",
          "oneOf": [
            {
              "type": "string"
            },
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          ]
        },
        "membership": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          ]
        },
        "platform": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          ]
        },
        "support": {
          "enum": [
            "full",
            "partial",
            "none",
            "N/A"
          ],
          "type": "string"
        },
        "version_added": {
          "type": "string"
        }
      },
      "required": [
        "description",
        "support"
      ],
      "additionalProperties": false,
      "type": "object"
    },
    "datatype": {
      "enum": [
        "str",
        "list",
        "dict",
        "bool",
        "int",
        "float",
        "path",
        "raw",
        "jsonarg",
        "json",
        "bytes",
        "bits"
      ],
      "type": "string"
    },
    "deprecated_alias": {
      "properties": {
        "collection_name": {
          "type": "string"
        },
        "date": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "version": {
          "type": "string"
        }
      },
      "required": [
        "name"
      ],
      "type": "object"
    },
    "entry_point": {
      "type": "object",
      "properties": {
        "attributes": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/attribute"
          }
        },
        "author": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          ]
        },
        "description": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          ]
        },
        "examples": {
          "type": "string"
        },
        "options": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/option"
          }
        },
        "seealso": {
          "items": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "description": {
                    "type": "string"
                  },
                  "module": {
                    "type": "string"
                  }
                },
                "required": [
                  "module"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "description": {
                    "type": "string"
                  },
                  "plugin": {
                    "type": "string"
                  },
                  "plugin_type": {
                    "type": "string"
                  }
                },
                "required": [
                  "plugin",
                  "plugin_type"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "description": {
                    "type": "string"
                  },
                  "ref": {
                    "type": "string"
                  }
                },
                "required": [
                  "description",
                  "ref"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "description": {
                    "type": "string"
                  },
                  "link": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  }
                },
                "required": [
                  "description",
                  "link",
                  "name"
                ],
                "additionalProperties": false
              }
            ]
          },
          "type": "array"
        },
        "short_description": {
          "type": "string"
        },
        "version_added": {
          "type": "string"
        }
      },
      "title": "Entry Point",
      "additionalProperties": false
    },
    "full-jinja": {
      "pattern": "^\\{[\\{%](.|[\r\n])*[\\}%]\\}$",
      "type": "string"
    },
    "option": {
      "title": "Option",
      "markdownDescription": "See [argument-spec](https://docs.ansible.com/projects/ansible/latest/dev_guide/developing_program_flow_modules.html#argument-spec)",
      "properties": {
        "apply_defaults": {
          "type": "string"
        },
        "choices": {
          "oneOf": [
            {
              "type": "array"
            },
            {
              "$ref": "#/$defs/full-jinja",
              "type": "string"
            }
          ]
        },
        "default": {
          "default": "None"
        },
        "description": {
          "description": "Detailed explanation of what this option does. It should be written in full sentences.",
          "oneOf": [
            {
              "type": "string"
            },
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          ]
        },
        "elements": {
          "$ref": "#/$defs/datatype"
        },
        "fallback": {
          "default": "None",
          "type": "string"
        },
        "no_log": {
          "default": false,
          "type": "boolean"
        },
        "option-name": {
          "description": "The name of the option/argument.",
          "type": "string"
        },
        "options": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/option"
          }
        },
        "required": {
          "default": false,
          "type": "boolean"
        },
        "mutually_exclusive": {
          "type": "array",
          "items": {
            "items": {
              "type": "string"
            }
          }
        },
        "required_together": {
          "type": "array",
          "items": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required_one_of": {
          "type": "array",
          "items": {
            "items": {
              "type": "string"
            }
          }
        },
        "required_if": {
          "type": "array",
          "items": {
            "type": "array",
            "prefixItems": [
              {
                "type": "string"
              },
              {},
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              {
                "type": "boolean"
              }
            ],
            "minItems": 3,
            "maxItems": 4
          }
        },
        "required_by": {
          "type": "object",
          "additionalProperties": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          }
        },
        "type": {
          "$ref": "#/$defs/datatype",
          "markdownDescription": "See [argument-spec](https://docs.ansible.com/projects/ansible/latest/dev_guide/developing_program_flow_modules.html#argument-spec"
        },
        "version_added": {
          "type": "string"
        }
      },
      "removed_at_date": {
        "type": "string"
      },
      "removed_from_collection": {
        "type": "string"
      },
      "removed_in_version": {
        "type": "string"
      },
      "additionalProperties": false,
      "type": "object"
    }
  },
  "markdownDescription": "See [role-argument-validation](https://docs.ansible.com/projects/ansible/latest/user_guide/playbooks_reuse_roles.html#role-argument-validation)",
  "examples": [
    "meta/argument_specs.yml"
  ],
  "additionalProperties": false
}
