lorem.generate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/programmes-net/json-schema/programmes-net-lorem-generate-schema.json",
  "title": "lorem.generate",
  "description": "Generate lorem ipsum (or themed) placeholder text.",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/programmes-net-openapi.json#/components/schemas/lorem.generate",
  "type": "object",
  "properties": {
    "operation": {
      "const": "generate"
    },
    "input": {
      "type": "string",
      "description": "Unused (pass an empty string).",
      "maxLength": 32768
    },
    "options": {
      "type": "object",
      "properties": {
        "count": {
          "type": "integer",
          "description": "Number of units to generate.",
          "minimum": 1,
          "maximum": 100,
          "default": 3
        },
        "unitType": {
          "type": "string",
          "description": "What to count.",
          "enum": [
            "paragraphs",
            "sentences",
            "words"
          ],
          "default": "paragraphs"
        },
        "generatorType": {
          "type": "string",
          "description": "Word theme.",
          "enum": [
            "lorem",
            "hipster",
            "bacon",
            "corporate",
            "pirate",
            "zombie"
          ],
          "default": "lorem"
        },
        "startWithLorem": {
          "type": "boolean",
          "description": "Start with the classic \"Lorem ipsum\".",
          "default": true
        },
        "customWords": {
          "type": "string",
          "description": "Comma- or space-separated words to use instead of the theme.",
          "maxLength": 2000
        },
        "includeNumbers": {
          "type": "boolean",
          "description": "Mix numbers into the text.",
          "default": false
        },
        "includeSpecialChars": {
          "type": "boolean",
          "description": "Mix punctuation and symbols into the text.",
          "default": false
        }
      }
    }
  },
  "required": [
    "operation"
  ]
}