Schema for Stitch Request Settings

---
$id: https://skeleton.botmd.io/stitch/RequestSettings.schema
$schema: http://json-schema.org/draft-07/schema#

title: Request Settings
description: These additional settings will be used with HTTPS source URLs in the request.

type: object
additionalProperties: false
required: []

properties:
  method:
    title: Method
    description: Request method. Defaults to incoming request method.
    enum: [get, post, put, patch, delete, head, options]

  params:
    title: Params
    description: Dictionary or string (will be sent as-is) to send in the query string for the Request.

    oneOf:
      - title: Dictionary
        type: object
        additionalProperties:
          type: string

      - title: String
        type: string
    #end oneOf
  #end params

  json:
    title: JSON
    description: A JSON serializable Python object to send in the body of the Request.

    $ref: "/skeleton/Any.schema"
  #end json

  headers:
    title: Headers
    description: Dictionary of HTTP Headers to send with the Request.

    type: object
    additionalProperties:
      type: string

  auth:
    title: Auth
    description: Auth tuple to enable Basic HTTP Auth.

    type: array
    items:
      - title: User
        type: string
      - title: Password
        type: string

  allow_redirects:
    title: Allow Redirects
    description: Enable/disable GET/OPTIONS/POST/PUT/PATCH/DELETE/HEAD redirection. Defaults to `true`.

    type: boolean

  timeout:
    title: Timeout
    description: How many seconds to wait for the server to send data before giving up. Defaults to 3.
    type: number
#end properties