RequestTerminationPluginConfig

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RequestTerminationPluginConfig",
  "title": "RequestTerminationPluginConfig",
  "x-speakeasy-entity": "PluginRequestTermination",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "body": {
          "description": "The raw response body to send. This is mutually exclusive with the `config.message` field.",
          "type": "string"
        },
        "content_type": {
          "description": "Content type of the raw response configured with `config.body`.",
          "type": "string"
        },
        "echo": {
          "description": "When set, the plugin will echo a copy of the request back to the client. The main usecase for this is debugging. It can be combined with `trigger` in order to debug requests on live systems without disturbing real traffic.",
          "type": "boolean",
          "default": false
        },
        "message": {
          "description": "The message to send, if using the default response generator.",
          "type": "string"
        },
        "status_code": {
          "description": "The response code to send. Must be an integer between 100 and 599.",
          "type": "integer",
          "default": 503,
          "maximum": 599,
          "minimum": 100
        },
        "trigger": {
          "description": "A string representing an HTTP header name.",
          "type": "string"
        }
      }
    },
    "consumer": {
      "description": "If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "consumer_group": {
      "description": "If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "name": {
      "const": "request-termination"
    },
    "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"
        }
      }
    }
  }
}