Skip to content

Commit d56981e

Browse files
fix
Signed-off-by: Abhishek Choudhary <[email protected]>
1 parent a18af82 commit d56981e

File tree

3 files changed

+24
-9
lines changed

3 files changed

+24
-9
lines changed

apisix/plugins/openid-connect.lua

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,6 @@ local schema = {
9999
port = {
100100
type = "integer", minimum = 1, default = 6379,
101101
},
102-
socket = {
103-
type = "string"
104-
},
105102
username = {
106103
type = "string", minLength = 1,
107104
},
@@ -110,30 +107,40 @@ local schema = {
110107
},
111108
database = {
112109
type = "integer", minimum = 0, default = 0,
110+
description = "redis database index",
113111
},
114112
prefix = {
115-
type = "string", default = "sessions"
113+
type = "string",
114+
default = "sessions",
115+
description = "prefix for keys stored in redis"
116116
},
117117
ssl = {
118118
type = "boolean", default = false,
119+
description = "enable ssl",
119120
},
120121
ssl_verify = {
121122
type = "boolean", default = false,
123+
description = "verify ssl certificate",
122124
},
123125
server_name = {
124126
type = "string",
127+
description = "The server name for the new TLS SNI extension.",
125128
},
126129
connect_timeout = {
127130
type = "integer", minimum = 1, default = 1000,
131+
description = "connect timeout in milliseconds",
128132
},
129133
send_timeout = {
130134
type = "integer", minimum = 1, default = 1000,
135+
description = "send timeout in milliseconds",
131136
},
132137
read_timeout = {
133138
type = "integer", minimum = 1, default = 1000,
139+
description = "read timeout in milliseconds",
134140
},
135141
keepalive_timeout = {
136-
type = "integer", minimum = 1000, default = 10000
142+
type = "integer", minimum = 1000, default = 10000,
143+
description = "keepalive timeout in milliseconds",
137144
},
138145
}
139146
}

docs/en/latest/plugins/openid-connect.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,12 @@ The `openid-connect` Plugin supports the integration with [OpenID Connect (OIDC)
7676
| session.redis.database | integer | False | 0 | | Redis database index. |
7777
| session.redis.prefix | string | False | sessions | | Redis key prefix. |
7878
| session.redis.ssl | boolean | False | false | | Enable SSL for Redis connection. |
79+
| session.redis.ssl_verify | boolean | False | false | | Verify SSL certificate. |
7980
| session.redis.server_name | string | False | | | Redis server name for SNI. |
80-
| session.redis.auth | string | False | | | Alias for `session.redis.password`. |
81+
| session.redis.connect_timeout | integer | False | 1000 | | Connect timeout in milliseconds. |
82+
| session.redis.send_timeout | integer | False | 1000 | | Send timeout in milliseconds. |
83+
| session.redis.read_timeout | integer | False | 1000 | | Read timeout in milliseconds. |
84+
| session.redis.keepalive_timeout | integer | False | 10000 | | Keepalive timeout in milliseconds. |
8185
| session_contents | object | False | | | Session content configurations. If unconfigured, all data will be stored in the session. |
8286
| session_contents.access_token | boolean | False | | | If true, store the access token in the session. |
8387
| session_contents.id_token | boolean | False | | | If true, store the ID token in the session. |

docs/zh/latest/plugins/openid-connect.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,13 @@ description: openid-connect 插件支持与 OpenID Connect (OIDC) 身份提供
7575
| session.redis.username | string || | | Redis 用户名。 |
7676
| session.redis.database | integer || 0 | | Redis 数据库索引。 |
7777
| session.redis.prefix | string || sessions | | Redis 键前缀。 |
78-
| session.redis.ssl | boolean || false | | 启用 Redis SSL 连接。 |
79-
| session.redis.server_name | string || | | Redis SNI 服务器名称。 |
80-
| session.redis.auth | string || | | `session.redis.password` 的别名。 |
78+
| session.redis.ssl | boolean || false | | 启用 Redis SSL 连接。 |
79+
| session.redis.ssl_verify | boolean || false | | 验证 SSL 证书。 |
80+
| session.redis.server_name | string || | | Redis SNI 服务器名称。 |
81+
| session.redis.connect_timeout | integer || 1000 | | 连接超时时间(毫秒)。 |
82+
| session.redis.send_timeout | integer || 1000 | | 发送超时时间(毫秒)。 |
83+
| session.redis.read_timeout | integer || 1000 | | 读取超时时间(毫秒)。 |
84+
| session.redis.keepalive_timeout | integer || 10000 | | Keepalive 超时时间(毫秒)。 |
8185
| unauth_action | string || auth | ["auth","deny","pass"] | 未经身份验证的请求的操作。设置为 `auth` 时,重定向到 OpenID 提供程序的身份验证端点。设置为 `pass` 时,允许请求而无需身份验证。设置为 `deny` 时,返回 401 未经身份验证的响应,而不是启动授权代码授予流程。|
8286
| session_contents | object || | | 会话内容配置。如果未配置,将把所有数据存储在会话中。 |
8387
| session_contents.access_token | boolean || | | 若为 true,则将访问令牌存储在会话中。 |

0 commit comments

Comments
 (0)