Skip to content

Generate JSON Schemas for 3.10.x #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lena-larionova merged 1 commit into from
Mar 25, 2025
Merged

Generate JSON Schemas for 3.10.x #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions json_schemas/konnect-application-auth/3.10.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2246,9 +2246,7 @@
}
},
"required": [
"cluster_cache_redis",
"issuer",
"redis"
"issuer"
],
"type": "object"
},
Expand Down
63 changes: 56 additions & 7 deletions json_schemas/request-callout/3.10.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"config": {
"properties": {
"cache": {
"description": "Plugin global caching configuration.",
"properties": {
"cache_ttl": {
"default": 300,
Expand Down Expand Up @@ -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",
Expand All @@ -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"
}
},
Expand All @@ -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": [

Expand All @@ -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.<name>",
"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"
}
},
Expand All @@ -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,
Expand All @@ -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"
}
},
Expand All @@ -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"
}
},
Expand All @@ -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"
}
},
Expand All @@ -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"
Expand All @@ -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"
}
},
Expand All @@ -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"
}
},
Expand All @@ -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.<name>.response.body.",
"type": "boolean"
}
},
Expand All @@ -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.<name>.response.headers.",
"type": "boolean"
}
},
Expand Down Expand Up @@ -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"
}
},
Expand All @@ -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"
}
},
Expand All @@ -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"
}
},
Expand Down
2 changes: 1 addition & 1 deletion json_schemas/session/3.10.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@
"type": "number"
},
"secret": {
"default": "e5LBiB0qbGGgh4BBf3E8HWBbKBFHsz007KeVri6SIUAp",
"default": "WKzHLADIGTA9J6nV29ppiqFxmLWstNnPGEtEJ2gQA70z",
"description": "The secret that is used in keyed HMAC generation.",
"type": "string"
},
Expand Down