CreateModuleRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/revyl/json-schema/revyl-create-module-request-schema.json",
  "title": "CreateModuleRequest",
  "description": "Request model for creating a new module",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/revyl-modules-api-openapi.yml#/components/schemas/CreateModuleRequest",
  "properties": {
    "blocks": {
      "description": "Array of block objects",
      "items": {
        "$ref": "#/$defs/ModuleBlock"
      },
      "title": "Blocks",
      "type": "array"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional description",
      "title": "Description"
    },
    "name": {
      "description": "Name of the module",
      "minLength": 1,
      "title": "Name",
      "type": "string"
    }
  },
  "required": [
    "name",
    "blocks"
  ],
  "type": "object",
  "$defs": {
    "ModuleBlock": {
      "description": "Individual block within a module - matches FrontendBlock structure.\n\nThe id field is auto-generated if not provided, so blocks from any client\n(frontend, CLI, direct API) are always stored with valid IDs.",
      "properties": {
        "children": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/ModuleBlock"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Children"
        },
        "condition": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Condition"
        },
        "elseChildren": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/ModuleBlock"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Elsechildren"
        },
        "file": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "File"
        },
        "file_uri": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "File Uri"
        },
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Block ID (auto-generated if not provided)",
          "title": "Id"
        },
        "module": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Module"
        },
        "module_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Module Id"
        },
        "script": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Script"
        },
        "script_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Script Id"
        },
        "step_description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Step Description"
        },
        "step_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Step Type"
        },
        "thenChildren": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/ModuleBlock"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Thenchildren"
        },
        "type": {
          "title": "Type",
          "type": "string"
        },
        "variable_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Variable Name"
        },
        "variable_scope": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Variable Scope"
        }
      },
      "required": [
        "type"
      ],
      "title": "ModuleBlock",
      "type": "object"
    }
  }
}