ConnectionConfiguration

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/peaka/main/json-schema/peaka-connection-configuration-schema.json",
  "title": "ConnectionConfiguration",
  "x-generated": "2026-10-21",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/peaka-api-openapi.json#/components/schemas/ConnectionConfiguration",
  "type": "object",
  "properties": {
    "connectionType": {
      "type": "string",
      "description": "The type of the connection. e.g. stripe, airtable, etc."
    },
    "connectionTypeLabel": {
      "type": "string",
      "description": "The label for the connection type."
    },
    "name": {
      "type": "string",
      "description": "The name of the connection."
    },
    "authorizationType": {
      "type": "string",
      "description": "The type of authorization used for the connection. e.g. oauth2, api_key, bearer_token, etc."
    },
    "credentialSchemaType": {
      "type": "string",
      "description": "The type of the credential schema used for the connection."
    },
    "redirectRequired": {
      "type": "boolean",
      "description": "Flag to indicate if the connection requires redirection to a 3rd party platform.\n\n e.g. OAuth2 connections often require redirection to the 3rd party platform for authorization.\n\n If this flag is set to true, the connection will be redirected to the 3rd party platform for authorization.\n\n According to your use case, some extra steps may be required to complete the authorization process.\n\n See: https://www.peaka.com/docs/cookbook/how-to-create-oauth2-based-connections-via-peaka"
    },
    "category": {
      "type": "string",
      "description": "The category of the connection."
    },
    "configuration": {
      "type": "array",
      "description": "The list of configuration fields for the connection.",
      "items": {
        "$ref": "#/$defs/ConnectionConfigurationItem"
      }
    },
    "documentationUrl": {
      "type": "string",
      "description": "The URL for the documentation of the connection."
    },
    "keywords": {
      "type": "array",
      "description": "Search aliases and abbreviations for the connection type, e.g. [\"pg\", \"psql\", \"postgre\"] for POSTGRES.\n Useful for matching a user's or an LLM's free-text name for a data source to a connection type.",
      "items": {
        "type": "string"
      }
    }
  },
  "$defs": {
    "ConnectionConfigurationItem": {
      "type": "object",
      "properties": {
        "fieldName": {
          "type": "string",
          "description": "The name of the field."
        },
        "fieldType": {
          "type": "string",
          "description": "The type of the field. `object` is a map of string keys to string values, e.g. Oracle's `advancedParameters`: {\"metadata.cache-ttl\": \"10m\"}.",
          "enum": [
            "text",
            "number",
            "boolean",
            "object"
          ]
        },
        "required": {
          "type": "boolean",
          "description": "Indicates whether the field is required."
        },
        "description": {
          "type": "string",
          "description": "The description of the field."
        }
      },
      "description": "Represents a configuration field for a connection."
    }
  }
}