schemas.schema-form.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gravitee-policy-cache Show documentation
Description of the Cache Gravitee Policy
The newest version!
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "cacheName": {
            "title": "Cache name",
            "description": "The cache resource used to store the element.",
            "type": "string",
            "x-schema-form": {
                "event": {
                    "name": "fetch-resources",
                    "regexTypes": "^cache"
                }
            },
            "gioConfig": {
                "uiType": "resource-type",
                "uiTypeProps": {
                    "resourceType": "cache"
                }
            }
        },
        "key": {
            "title": "Key",
            "description": "The key used to store the element (Support EL).",
            "type": "string",
            "x-schema-form": {
                "expression-language": true
            }
        },
        "timeToLiveSeconds": {
            "title": "Time to live (in seconds)",
            "default": 600,
            "description": "Time to live of the element put in cache (Default to 10 minutes).",
            "type": "integer"
        },
        "methods": {
            "title": "Methods to cache",
            "description": "Select which method you want to cache.",
            "type": "array",
            "default": ["GET", "OPTIONS", "HEAD"],
            "items": {
                "type": "string",
                "enum": ["CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"]
            }
        },
        "responseCondition": {
            "title": "Response Condition",
            "description": "(Support EL)",
            "type": "string",
            "x-schema-form": {
                "expression-language": true
            },
            "gioConfig": {
                "banner": {
                    "title": "Response Condition",
                    "text": "Add an extra condition (with Expression Language) based on the response to activate cache.
For example use {#upstreamResponse.status == 200} to only cache 200 responses status. By default, 2xx only are cached.
 \uD83D\uDEA8 upstreamResponse.content is not supported."
                }
            }
        },
        "useResponseCacheHeaders": {
            "title": "Use response headers",
            "description": "Time to live based on 'Cache-Control' and / or 'Expires' headers from response.",
            "type": "boolean"
        },
        "scope": {
            "title": "Scope",
            "type": "string",
            "default": "APPLICATION",
            "enum": ["API", "APPLICATION"],
            "gioConfig": {
                "banner": {
                    "title": "Scope",
                    "text": "Cached response can be set for a single consumer (application) or for all consumers.
WARNING: Please be aware that by using an \"API\" scope, data will be shared between all consumers!"
                }
            }
        }
    },
    "required": ["cacheName", "timeToLiveSeconds"]
}