External

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adobe/main/json-schema/adobe-html-to-pdf-external-schema.json",
  "title": "External",
  "description": "Params for converting HTML to PDF Operation using external storage.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/adobe-html-to-pdf-api-openapi.yml#/components/schemas/HtmlToPdfExternal",
  "type": "object",
  "properties": {
    "input": {
      "$ref": "#/$defs/ExternalStorageInput"
    },
    "output": {
      "$ref": "#/$defs/ExternalStorageOutput"
    },
    "params": {
      "description": "Params for HTML to PDF processing",
      "type": "object",
      "properties": {
        "json": {
          "description": "JavaScript variables to be placed in global scope to reference while rendering the HTML. This mechanism is intended to be used to supply data that might otherwise be retrieved using ajax requests. The actual mechanics of accessing this content varies depending if rendering from a zip file or from a url. When rendering from a zip file, the source collateral must include a script element such as:\\<script src='./json.js' type='text/javascript'>\\</script>When rendering from a URL, the content of this json object is injected into the browser VM before the page is rendered.",
          "type": "string",
          "default": null
        },
        "includeHeaderFooter": {
          "description": "Determine whether to add default headers and footers to the output pages. The default header includes a short date and the contents of document title. The default footer includes a file name and a page n/m reference.",
          "type": "boolean",
          "default": false
        },
        "pageLayout": {
          "description": "Parameters for specifying the layout of the output page.",
          "type": "object",
          "properties": {
            "pageWidth": {
              "description": "The width (in inches) of the output paper size.",
              "type": "number",
              "default": [
                11
              ]
            },
            "pageHeight": {
              "description": "The height (in inches) of the output paper size.",
              "type": "number",
              "default": [
                8.5
              ]
            }
          }
        },
        "waitTimeToLoad": {
          "description": "Specifies the maximum time (in milliseconds) to wait before finalizing the PDF. After this duration, the HTML is captured and converted into a PDF, regardless of whether all elements have finished loading or rendering. If a customer provides a custom value, it overrides the default.",
          "type": "number",
          "default": 100
        },
        "includeRenderedHtml": {
          "description": "When set to `true`, the operation returns a ZIP file containing both the generated PDF and the rendered HTML content.Valid and accepted input type of files are - HTML files and ZIP files (containing HTML + assets)",
          "type": "boolean",
          "default": false
        },
        "createTaggedPDF": {
          "description": "Determines whether the output PDF should be tagged. Tagged PDFs improve heading levels, reading order, lists, links, references, and tables, while adding some processing overhead. They also enhance screen reader navigation. If not specified, the API generates a tagged PDF by default.",
          "type": "boolean",
          "default": true
        }
      }
    },
    "notifiers": {
      "$ref": "#/$defs/notifiers"
    }
  },
  "required": [
    "input"
  ],
  "additionalProperties": false,
  "$defs": {
    "ExternalStorageInput": {
      "title": "Input",
      "description": "Params representing input object.",
      "type": "object",
      "properties": {
        "uri": {
          "description": "Input file Download Signed URI.",
          "type": "string"
        },
        "storage": {
          "description": "Specifies the type of the external storage",
          "type": "string",
          "enum": [
            "S3",
            "SHAREPOINT",
            "DROPBOX",
            "BLOB"
          ]
        }
      },
      "required": [
        "uri"
      ]
    },
    "ExternalStorageOutput": {
      "title": "Output",
      "description": "Params representing output object",
      "type": "object",
      "properties": {
        "uri": {
          "description": "Output file Upload Signed URI.",
          "type": "string"
        },
        "storage": {
          "description": "Specifies the type of the external storage",
          "type": "string",
          "enum": [
            "S3",
            "SHAREPOINT",
            "DROPBOX",
            "BLOB"
          ]
        }
      }
    },
    "notifiers": {
      "description": "Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the <a href=\"https://developer.adobe.com/document-services/docs/overview/pdf-services-api/howtos/webhook-notification/\">documentation</a>.",
      "type": "array",
      "items": {
        "properties": {
          "type": {
            "description": "Specifies the notifier type. Currently supported value is \"CALLBACK\" only.",
            "type": "string"
          },
          "data": {
            "description": "Specifies the data needed to invoke the notifier.",
            "type": "object"
          }
        },
        "required": [
          "type",
          "data"
        ]
      }
    }
  }
}