overlay_client.yaml

overlay: 1.0.0
info:
  title: Overlay openapi.json to add client-specific features
  version: 0.0.0
actions:
  - target: $["components"]["schemas"]["partition_parameters"]["properties"]
    update:
      "split_pdf_page":
        {
          "type": "boolean",
          "title": "Split Pdf Page",
          "description": "Should the pdf file be split at client. Ignored on backend.",
          "default": true,
        }
  - target: $["components"]["schemas"]["partition_parameters"]["properties"]
    update:
      "split_pdf_concurrency_level":
        {
          "type": "integer",
          "title": "Split Pdf Concurrency Level",
          "description": "Number of maximum concurrent requests made when splitting PDF. Ignored on backend.",
          "default": 5,
        }
  - target: $["components"]["schemas"]["partition_parameters"]["properties"]
    update:
      "split_pdf_page_range":
        {
          "type": "array",
          "title": "Split Pdf Page Range",
          "description": "When `split_pdf_page is set to `True`, this parameter selects a subset of the pdf to send to the API. The parameter is a list of 2 integers within the range [1, length_of_pdf]. An Error is thrown if the given range is invalid. Ignored on backend.",
          "items": {"type": "integer"},
          "minItems": 2,
          "maxItems": 2,
          "example": [1, 10],
        }
  - target: $["components"]["schemas"]["partition_parameters"]["properties"]
    update:
      "split_pdf_allow_failed":
        {
          "title": "Split Pdf Allow Failed",
          "description": "When `split_pdf_page` is set to `True`, this parameter defines the behavior when some of the parallel requests fail. By default `split_pdf_allow_failed` is set to `False` and any failed request send to the API will make the whole process break and raise an Exception. If `split_pdf_allow_failed` is set to `True`, the errors encountered while sending parallel requests will not break the processing - the resuling list of Elements will miss the data from errored pages.",
          "type": "boolean",
          "default": false,
        }