transformation

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/folio/main/json-schema/folio-transformation-schema.json",
  "title": "transformation",
  "description": "A transformation pipeline configuration header that steps can be assigned to",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/folio-mod-inventory-update-inventory-import-1-0-openapi.yml#/components/schemas/transformation",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for the transformation pipeline."
    },
    "name": {
      "type": "string",
      "description": "Name of the transformation pipeline."
    },
    "description": {
      "type": "string",
      "description": "Free-text details about the pipeline."
    },
    "steps": {
      "type": "array",
      "description": "The transformation steps making up this pipeline, in order of execution.",
      "items": {
        "type": "object",
        "description": "A transformation step",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "The ID of the step at this position in the transformation pipeline."
          },
          "name": {
            "type": "string",
            "description": "The (unique) name of the step."
          }
        },
        "required": [
          "id"
        ]
      }
    },
    "metadata": {
      "$ref": "#/$defs/metadata"
    }
  },
  "$defs": {
    "metadata": {
      "type": "object",
      "description": "For tagging records with current time and user ID on create or update.",
      "properties": {
        "createdDate": {
          "type": "string",
          "description": "Time stamp for the records creation.",
          "readOnly": true
        },
        "createdByUserId": {
          "type": "string",
          "format": "uuid",
          "description": "ID of the user creating the record.",
          "readOnly": true
        },
        "updatedDate": {
          "type": "string",
          "description": "Time stamp for the most recent update of the record.",
          "readOnly": true
        },
        "updatedByUserId": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the user who most recently updated the record.",
          "readOnly": true
        }
      }
    }
  }
}