OpaPluginConfig

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OpaPluginConfig",
  "title": "OpaPluginConfig",
  "x-speakeasy-entity": "PluginOpa",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "include_body_in_opa_input": {
          "type": "boolean",
          "default": false
        },
        "include_consumer_in_opa_input": {
          "description": "If set to true, the Kong Gateway Consumer object in use for the current request (if any) is included as input to OPA.",
          "type": "boolean",
          "default": false
        },
        "include_parsed_json_body_in_opa_input": {
          "description": "If set to true and the `Content-Type` header of the current request is `application/json`, the request body will be JSON decoded and the decoded struct is included as input to OPA.",
          "type": "boolean",
          "default": false
        },
        "include_route_in_opa_input": {
          "description": "If set to true, the Kong Gateway Route object in use for the current request is included as input to OPA.",
          "type": "boolean",
          "default": false
        },
        "include_service_in_opa_input": {
          "description": "If set to true, the Kong Gateway Service object in use for the current request is included as input to OPA.",
          "type": "boolean",
          "default": false
        },
        "include_uri_captures_in_opa_input": {
          "description": "If set to true, the regex capture groups captured on the Kong Gateway Route's path field in the current request (if any) are included as input to OPA.",
          "type": "boolean",
          "default": false
        },
        "opa_host": {
          "description": "A string representing a host name, such as example.com.",
          "type": "string",
          "default": "localhost"
        },
        "opa_path": {
          "description": "A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).",
          "type": "string"
        },
        "opa_port": {
          "description": "An integer representing a port number between 0 and 65535, inclusive.",
          "type": "integer",
          "default": 8181,
          "maximum": 65535,
          "minimum": 0
        },
        "opa_protocol": {
          "description": "The protocol to use when talking to Open Policy Agent (OPA) server. Allowed protocols are `http` and `https`.",
          "type": "string",
          "default": "http",
          "enum": [
            "http",
            "https"
          ]
        },
        "ssl_verify": {
          "description": "If set to true, the OPA certificate will be verified according to the CA certificates specified in lua_ssl_trusted_certificate.",
          "type": "boolean",
          "default": true
        }
      },
      "required": [
        "opa_path"
      ]
    },
    "name": {
      "const": "opa"
    },
    "protocols": {
      "description": "A set of strings representing HTTP protocols.",
      "type": "array",
      "items": {
        "enum": [
          "grpc",
          "grpcs",
          "http",
          "https"
        ],
        "type": "string"
      },
      "format": "set",
      "default": [
        "grpc",
        "grpcs",
        "http",
        "https"
      ]
    },
    "route": {
      "description": "If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "service": {
      "description": "If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "config"
  ]
}