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": "This parameter determines if the PDF file should be split on the client side. It's an internal parameter for the Python client and is not sent to the backend.",
          "default": true,
        }
  - 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]. A ValueError is thrown if the given range is invalid. It's an internal parameter for the Python client and is not sent to the backend.",
          "items": {"type": "integer"},
          "minItems": 2,
          "maxItems": 2,
          "example": [1, 10],
        }
  - target: $["components"]["schemas"]["partition_parameters"]["properties"]
    update:
      "split_pdf_concurrency_level":
        {
          "title": "Split Pdf Concurrency Level",
          "description": "When `split_pdf_page` is set to `True`, this parameter specifies the number of workers used for sending requests when the PDF is split on the client side. It's an internal parameter for the Python client and is not sent to the backend.",
          "type": "integer",
          "default": 5,
        }
  - target: $["components"]["schemas"]["partition_parameters"]["properties"][*].anyOf[0]
    description: Add a null default to all optional parameters. Prevents the sdk from sending a default string when param is not specified.
    update:
        "default": null