rulesets_ForceConnectionCloseRule

APIs.ioEngineeringPlatform
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-rulesets-forceconnectioncloserule-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/rulesets_ForceConnectionCloseRule",
  "title": "rulesets_ForceConnectionCloseRule",
  "allOf": [
    {
      "$ref": "#/components/schemas/rulesets_Rule"
    },
    {
      "properties": {
        "action": {
          "enum": [
            "force_connection_close"
          ]
        },
        "description": {
          "example": "Closes ongoing HTTP connections. This action does not block a request, but it forces the client to reconnect. For HTTP/2 and HTTP/3 connections, the connection will be closed even if it breaks other requests running on the same connection."
        }
      },
      "title": "Force Connection Close rule"
    }
  ]
}