apicast-policy.json

{
  "$schema": "http://apicast.io/policy-v1/schema#manifest#",
  "name": "3scale auth caching",
  "summary": "Controls how to cache authorizations returned by the 3scale backend.",
  "description":
    ["Configures a cache for the authentication calls against the 3scale ",
     "backend. This policy support four kinds of caching: \n",
     " - Strict: it only caches authorized calls. Denied and failed calls ",
     "invalidate the cache entry.\n",
     " - Resilient: caches authorized and denied calls. Failed calls do not ",
     "invalidate the cache. This allows us to authorize and deny calls ",
     "according to the result of the last request made even when backend is ",
     "down.\n",
     "- Allow: caches authorized and denied calls. When backend is ",
     "unavailable, it will cache an authorization. In practice, this means ",
     "that when backend is down _any_ request will be authorized unless last ",
     "call to backend for that request returned 'deny' (status code = 4xx). ",
     "Make sure to understand the implications of that before using this ",
     "mode. It makes sense only in very specific use cases.\n",
     "- None: disables caching."],
  "version": "builtin",
  "configuration": {
    "type": "object",
    "properties": {
      "caching_type": {
        "description": "Caching mode",
        "type": "string",
        "oneOf": [
          {
            "enum": ["strict"],
            "title": "Strict: cache only authorized calls."
          },
          {
            "enum": ["resilient"],
            "title": "Resilient: authorize according to last request when backend is down."
          },
          {
            "enum": ["allow"],
            "title": "Allow: when backend is down, allow everything unless seen before and denied."
          },
          {
            "enum": ["none"],
            "title": "None: disable caching."
          }
        ],
        "default": "none"
      }
    }
  }
}