Tenant job attributes

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/folio/main/json-schema/folio-tenant-attributes-schema.json",
  "title": "Tenant job attributes",
  "description": "Configuration how to install, upgrade or delete a module for a tenant",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/folio-folio-spring-support-tenant-openapi.yml#/components/schemas/tenantAttributes",
  "type": "object",
  "properties": {
    "module_from": {
      "type": "string",
      "description": "Existing module ID. If omitted, the module is not enabled already"
    },
    "module_to": {
      "type": "string",
      "description": "Target module ID. If omitted, the existing module is disabled"
    },
    "purge": {
      "type": "boolean",
      "description": "On disable should data also be purged",
      "default": true
    },
    "parameters": {
      "$ref": "#/$defs/parameters",
      "description": "Parameters that controls what tenant init (eg reference data)"
    }
  },
  "$defs": {
    "parameter": {
      "type": "object",
      "description": "Key/value parameter",
      "properties": {
        "key": {
          "type": "string",
          "description": "The key for this parameter"
        },
        "value": {
          "type": "string",
          "description": "The value of this parameter"
        }
      },
      "required": [
        "key"
      ]
    },
    "parameters": {
      "type": "object",
      "description": "List of key/value parameters",
      "items": {
        "$ref": "#/$defs/parameter"
      }
    }
  }
}