diff --git a/json_schemas/konnect-application-auth/3.10.json b/json_schemas/konnect-application-auth/3.10.json index 17240508..43573756 100644 --- a/json_schemas/konnect-application-auth/3.10.json +++ b/json_schemas/konnect-application-auth/3.10.json @@ -2246,9 +2246,7 @@ } }, "required": [ - "cluster_cache_redis", - "issuer", - "redis" + "issuer" ], "type": "object" }, diff --git a/json_schemas/request-callout/3.10.json b/json_schemas/request-callout/3.10.json index bd8473ad..3105e35c 100644 --- a/json_schemas/request-callout/3.10.json +++ b/json_schemas/request-callout/3.10.json @@ -3,6 +3,7 @@ "config": { "properties": { "cache": { + "description": "Plugin global caching configuration.", "properties": { "cache_ttl": { "default": 300, @@ -206,6 +207,7 @@ }, "strategy": { "default": "off", + "description": "The backing data store in which to hold cache entities. Accepted values are: `off`, `memory`, and `redis`.", "enum": [ "memory", "off", @@ -220,12 +222,15 @@ "type": "object" }, "callouts": { + "description": "A collection of callout objects, where each object represents an HTTPrequest made in the context of a proxy request.", "items": { "properties": { "cache": { + "description": "Callout caching configuration.", "properties": { "bypass": { "default": false, + "description": "If true, skips caching the callout response.", "type": "boolean" } }, @@ -238,6 +243,7 @@ "default": [ ], + "description": "An array of callout names the current callout depends on.This dependency determines the callout execution order.", "items": { "required": [ @@ -247,22 +253,28 @@ "type": "array" }, "name": { + "description": "A string identifier for a callout. A callout object is referenceablevia its name in the kong.ctx.shared.callouts.", "type": "string" }, "request": { + "description": "The customizations for the callout request.", "properties": { "body": { + "description": "Callout request body customizations.", "properties": { "custom": { "additionalProperties": true, + "description": "The custom body fields to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).", "type": "object" }, "decode": { "default": false, + "description": "If true, decodes the request's body to make it available for customizations.", "type": "boolean" }, "forward": { "default": false, + "description": "If true, forwards the incoming request's body to the callout request.", "type": "boolean" } }, @@ -272,19 +284,24 @@ "type": "object" }, "by_lua": { + "description": "Lua code that executes before the callout request is made.Standard Lua sandboxing restrictions apply.", "type": "string" }, "error": { + "description": "The error handling policy the plugin will apply to TCP and HTTP errors.", "properties": { "error_response_code": { "default": 400, + "description": "The error code to respond with if `on_error` is `fail` or if `retries` is achieved.", "type": "integer" }, "error_response_msg": { "default": "service callout error", + "description": "The error mesasge to respond with if `on_error` is `fail` or if `retries` is achieved.Templating with Lua expressions is supported.", "type": "string" }, "http_statuses": { + "description": "The list of HTTP status codes considered errors under the error handling policy.", "items": { "maximum": 999, "minimum": 100, @@ -306,6 +323,7 @@ }, "retries": { "default": 2, + "description": "The number of retries the plugin will attempt on TCP and HTTP errors if `on_error` is set to `retry`.", "type": "integer" } }, @@ -315,13 +333,16 @@ "type": "object" }, "headers": { + "description": "Callout request header customizations.", "properties": { "custom": { "additionalProperties": true, + "description": "The custom headers to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).", "type": "object" }, "forward": { "default": false, + "description": "If true, forwards the incoming request's headers to the callout request. ", "type": "boolean" } }, @@ -331,21 +352,25 @@ "type": "object" }, "http_opts": { + "description": "HTTP connection parameters.", "properties": { "proxy": { + "description": "Proxy settings.", "properties": { "auth_password": { + "description": "The password to authenticate with, if the forward proxy is protected by basic authentication.", "type": "string" }, "auth_username": { + "description": "The username to authenticate with, if the forward proxy is protected by basic authentication.", "type": "string" }, "http_proxy": { - "description": "A string representing a URL, such as https://example.com/path/to/resource?q=search.", + "description": "The HTTP proxy URL. This proxy server will be used for HTTP requests.", "type": "string" }, "https_proxy": { - "description": "A string representing a URL, such as https://example.com/path/to/resource?q=search.", + "description": "The HTTPS proxy URL. This proxy server will be used for HTTPS requests.", "type": "string" } }, @@ -355,28 +380,31 @@ "type": "object" }, "ssl_server_name": { + "description": "The SNI used in the callout request. Defaults to host if omitted.", "type": "string" }, "ssl_verify": { "default": false, + "description": "If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.", "type": "boolean" }, "timeouts": { + "description": "Socket timeouts in milliseconds. All or none must be set.", "properties": { "connect": { - "description": "An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.", + "description": "The socket connect timeout.", "maximum": 2147483646, "minimum": 0, "type": "integer" }, "read": { - "description": "An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.", + "description": "The socket read timeout. ", "maximum": 2147483646, "minimum": 0, "type": "integer" }, "write": { - "description": "An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.", + "description": "The socket write timeout.", "maximum": 2147483646, "minimum": 0, "type": "integer" @@ -395,18 +423,21 @@ }, "method": { "default": "GET", - "description": "A string representing an HTTP method, such as GET, POST, PUT, or DELETE. The string must contain only uppercase letters.", + "description": "The HTTP method that will be requested.", "pattern": "^%u+$", "type": "string" }, "query": { + "description": "Callout request query param customizations.", "properties": { "custom": { "additionalProperties": true, + "description": "The custom query params to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).", "type": "object" }, "forward": { "default": false, + "description": "If true, forwards the incoming request's query params to the callout request. ", "type": "boolean" } }, @@ -416,7 +447,7 @@ "type": "object" }, "url": { - "description": "A string representing a URL, such as https://example.com/path/to/resource?q=search.", + "description": "The URL that will be requested.", "type": "string" } }, @@ -431,15 +462,18 @@ "type": "object" }, "response": { + "description": "Configurations of callout response handling.", "properties": { "body": { "properties": { "decode": { "default": false, + "description": "If true, decodes the response body before storing into the context. Only JSON is supported.", "type": "boolean" }, "store": { "default": true, + "description": "If false, skips storing the callout response body into kong.ctx.shared.callouts..response.body.", "type": "boolean" } }, @@ -449,12 +483,15 @@ "type": "object" }, "by_lua": { + "description": "Lua code that executes after the callout request is made, before caching takes place. Standard Lua sandboxing restrictions apply.", "type": "string" }, "headers": { + "description": "Callout response header customizations.", "properties": { "store": { "default": true, + "description": "If false, skips storing the callout response headers intokong.ctx.shared.callouts..response.headers.", "type": "boolean" } }, @@ -482,19 +519,24 @@ "type": "array" }, "upstream": { + "description": "Customizations to the upstream request.", "properties": { "body": { + "description": "Callout request body customizations.", "properties": { "custom": { "additionalProperties": true, + "description": "The custom body fields to be added in the upstream request body. Values can contain Lua expressions in the form $(some_lua_code).", "type": "object" }, "decode": { "default": true, + "description": "If true, decodes the request's body to make it available for upstream by_lua customizations.", "type": "boolean" }, "forward": { "default": true, + "description": "If false, skips forwarding the incoming request's body to the upstream request.", "type": "boolean" } }, @@ -504,16 +546,20 @@ "type": "object" }, "by_lua": { + "description": "Lua code that executes before the upstream request is made. Standard Lua sandboxing restrictions apply.", "type": "string" }, "headers": { + "description": "Callout request header customizations.", "properties": { "custom": { "additionalProperties": true, + "description": "The custom headers to be added in the upstream HTTP request. Values can contain Lua expressions in the form $(some_lua_code).", "type": "object" }, "forward": { "default": true, + "description": "If false, does not forward request headers to upstream request.", "type": "boolean" } }, @@ -523,13 +569,16 @@ "type": "object" }, "query": { + "description": "Upstream request query param customizations.", "properties": { "custom": { "additionalProperties": true, + "description": "The custom query params to be added in the upstream HTTP request. Values can contain Lua expressions in the form $(some_lua_code).", "type": "object" }, "forward": { "default": true, + "description": "If false, does not forward request query params to upstream request.", "type": "boolean" } }, diff --git a/json_schemas/session/3.10.json b/json_schemas/session/3.10.json index bb942b58..432e205c 100644 --- a/json_schemas/session/3.10.json +++ b/json_schemas/session/3.10.json @@ -154,7 +154,7 @@ "type": "number" }, "secret": { - "default": "e5LBiB0qbGGgh4BBf3E8HWBbKBFHsz007KeVri6SIUAp", + "default": "WKzHLADIGTA9J6nV29ppiqFxmLWstNnPGEtEJ2gQA70z", "description": "The secret that is used in keyed HMAC generation.", "type": "string" },