ProxyCachePluginConfig

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ProxyCachePluginConfig",
  "title": "ProxyCachePluginConfig",
  "x-speakeasy-entity": "PluginProxyCache",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "cache_control": {
          "description": "When enabled, respect the Cache-Control behaviors defined in RFC7234.",
          "type": "boolean",
          "default": false
        },
        "cache_ttl": {
          "description": "TTL, in seconds, of cache entities.",
          "type": "integer",
          "default": 300
        },
        "content_type": {
          "description": "Upstream response content types considered cacheable. The plugin performs an **exact match** against each specified value.",
          "type": "array",
          "items": {
            "type": "string"
          },
          "default": [
            "application/json",
            "text/plain"
          ]
        },
        "ignore_uri_case": {
          "type": "boolean",
          "default": false
        },
        "memory": {
          "type": "object",
          "properties": {
            "dictionary_name": {
              "description": "The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template.",
              "type": "string",
              "default": "kong_db_cache"
            }
          }
        },
        "request_method": {
          "description": "Downstream request methods considered cacheable.",
          "type": "array",
          "items": {
            "enum": [
              "GET",
              "HEAD",
              "PATCH",
              "POST",
              "PUT"
            ],
            "type": "string"
          },
          "default": [
            "GET",
            "HEAD"
          ]
        },
        "response_code": {
          "description": "Upstream response status code considered cacheable.",
          "type": "array",
          "items": {
            "maximum": 900,
            "minimum": 100,
            "type": "integer"
          },
          "default": [
            200,
            301,
            404
          ],
          "minLength": 1
        },
        "response_headers": {
          "description": "Caching related diagnostic headers that should be included in cached responses",
          "type": "object",
          "properties": {
            "X-Cache-Key": {
              "type": "boolean",
              "default": true
            },
            "X-Cache-Status": {
              "type": "boolean",
              "default": true
            },
            "age": {
              "type": "boolean",
              "default": true
            }
          }
        },
        "storage_ttl": {
          "description": "Number of seconds to keep resources in the storage backend. This value is independent of `cache_ttl` or resource TTLs defined by Cache-Control behaviors.",
          "type": "integer"
        },
        "strategy": {
          "description": "The backing data store in which to hold cache entities.",
          "type": "string",
          "enum": [
            "memory"
          ]
        },
        "vary_headers": {
          "description": "Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "vary_query_params": {
          "description": "Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration.",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "strategy"
      ]
    },
    "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": "proxy-cache"
    },
    "protocols": {
      "description": "A set of strings representing protocols.",
      "type": "array",
      "items": {
        "description": "A string representing a protocol, such as HTTP or HTTPS.",
        "enum": [
          "grpc",
          "grpcs",
          "http",
          "https",
          "tcp",
          "tls",
          "tls_passthrough",
          "udp",
          "ws",
          "wss"
        ],
        "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"
  ]
}