CanaryPluginConfig

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CanaryPluginConfig",
  "title": "CanaryPluginConfig",
  "x-speakeasy-entity": "PluginCanary",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "canary_by_header_name": {
          "description": "A string representing an HTTP header name.",
          "type": "string"
        },
        "duration": {
          "description": "The duration of the canary release in seconds.",
          "type": "number",
          "default": 3600
        },
        "groups": {
          "description": "The groups allowed to access the canary release.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "hash": {
          "description": "Hash algorithm to be used for canary release.\n\n* `consumer`: The hash will be based on the consumer.\n* `ip`: The hash will be based on the client IP address.\n* `none`: No hash will be applied.\n* `allow`: Allows the specified groups to access the canary release.\n* `deny`: Denies the specified groups from accessing the canary release.\n* `header`: The hash will be based on the specified header value.",
          "type": "string",
          "default": "consumer",
          "enum": [
            "allow",
            "consumer",
            "deny",
            "header",
            "ip",
            "none"
          ]
        },
        "hash_header": {
          "description": "A string representing an HTTP header name.",
          "type": "string"
        },
        "percentage": {
          "description": "The percentage of traffic to be routed to the canary release.",
          "type": "number",
          "maximum": 100,
          "minimum": 0
        },
        "start": {
          "description": "Future time in seconds since epoch, when the canary release will start. Ignored when `percentage` is set, or when using `allow` or `deny` in `hash`.",
          "type": "number"
        },
        "steps": {
          "description": "The number of steps for the canary release.",
          "type": "number",
          "default": 1000,
          "minimum": 1
        },
        "upstream_fallback": {
          "description": "Specifies whether to fallback to the upstream server if the canary release fails.",
          "type": "boolean",
          "default": false
        },
        "upstream_host": {
          "description": "A string representing a host name, such as example.com.",
          "type": "string"
        },
        "upstream_port": {
          "description": "An integer representing a port number between 0 and 65535, inclusive.",
          "type": "integer",
          "maximum": 65535,
          "minimum": 0
        },
        "upstream_uri": {
          "description": "The URI of the upstream server to be used for the canary release.",
          "type": "string",
          "minLength": 1
        }
      }
    },
    "name": {
      "const": "canary"
    },
    "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"
        }
      }
    }
  }
}