rulesets_CompressResponseRule

APIs.ioEngineeringPlatform
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-rulesets-compressresponserule-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/rulesets_CompressResponseRule",
  "title": "rulesets_CompressResponseRule",
  "allOf": [
    {
      "$ref": "#/components/schemas/rulesets_Rule"
    },
    {
      "properties": {
        "action": {
          "enum": [
            "compress_response"
          ]
        },
        "action_parameters": {
          "properties": {
            "algorithms": {
              "description": "Custom order for compression algorithms.",
              "example": [
                {
                  "name": "none"
                }
              ],
              "items": {
                "description": "Compression algorithm to enable.",
                "properties": {
                  "name": {
                    "description": "Name of compression algorithm to enable.",
                    "enum": [
                      "none",
                      "auto",
                      "default",
                      "gzip",
                      "brotli"
                    ],
                    "title": "Name",
                    "type": "string"
                  }
                },
                "title": "Compression Algorithm",
                "type": "object"
              },
              "title": "Algorithm",
              "type": "array"
            }
          }
        },
        "description": {
          "example": "Disable compression when address is not 1.1.1.1"
        }
      },
      "title": "Compression rule"
    }
  ]
}