This is an automated email from the ASF dual-hosted git repository.
nic-6443 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new 73bc3a436 fix: use description instead of title for field-level schema
doc strings (#13547)
73bc3a436 is described below
commit 73bc3a436510044ad9bcd8ee6210b36f7d6db435
Author: Nic <[email protected]>
AuthorDate: Fri Jun 12 16:48:41 2026 +0800
fix: use description instead of title for field-level schema doc strings
(#13547)
---
apisix/plugins/hmac-auth.lua | 2 +-
apisix/plugins/opentelemetry.lua | 10 +++++-----
t/plugin/hmac-auth2.t | 2 +-
3 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/apisix/plugins/hmac-auth.lua b/apisix/plugins/hmac-auth.lua
index 50c0c8ee6..6bef4d88f 100644
--- a/apisix/plugins/hmac-auth.lua
+++ b/apisix/plugins/hmac-auth.lua
@@ -60,7 +60,7 @@ local schema = {
},
validate_request_body = {
type = "boolean",
- title = "A boolean value telling the plugin to enable body
validation",
+ description = "A boolean value telling the plugin to enable body
validation",
default = false,
},
max_req_body_size = {
diff --git a/apisix/plugins/opentelemetry.lua b/apisix/plugins/opentelemetry.lua
index 2b99948a3..333e6816f 100644
--- a/apisix/plugins/opentelemetry.lua
+++ b/apisix/plugins/opentelemetry.lua
@@ -132,23 +132,23 @@ local schema = {
name = {
type = "string",
enum = {"always_on", "always_off", "trace_id_ratio",
"parent_base"},
- title = "sampling strategy",
+ description = "sampling strategy",
default = "always_off"
},
options = {
type = "object",
properties = {
fraction = {
- type = "number", title = "trace_id_ratio
fraction", default = 0
+ type = "number", description = "trace_id_ratio
fraction", default = 0
},
root = {
type = "object",
- title = "parent_base root sampler",
+ description = "parent_base root sampler",
properties = {
name = {
type = "string",
enum = {"always_on", "always_off",
"trace_id_ratio"},
- title = "sampling strategy",
+ description = "sampling strategy",
default = "always_off"
},
options = {
@@ -156,7 +156,7 @@ local schema = {
properties = {
fraction = {
type = "number",
- title = "trace_id_ratio fraction
parameter",
+ description = "trace_id_ratio
fraction parameter",
default = 0,
},
},
diff --git a/t/plugin/hmac-auth2.t b/t/plugin/hmac-auth2.t
index 7d6e8600c..90b3bd9c7 100644
--- a/t/plugin/hmac-auth2.t
+++ b/t/plugin/hmac-auth2.t
@@ -74,7 +74,7 @@ passed
ngx.HTTP_GET,
nil,
[[
-{"type":"object","$comment":"this is a mark for our injected plugin
schema","title":"work with route or service
object","properties":{"allowed_algorithms":{"type":"array","default":["hmac-sha1","hmac-sha256","hmac-sha512"],"items":{"type":"string","enum":["hmac-sha1","hmac-sha256","hmac-sha512"]},"minItems":1},"_meta":{"type":"object","properties":{"filter":{"description":"filter
determines whether the plugin needs to be executed at
runtime","type":"array"},"error_response":{"oneOf":[{"t [...]
+{"type":"object","$comment":"this is a mark for our injected plugin
schema","title":"work with route or service
object","properties":{"allowed_algorithms":{"type":"array","default":["hmac-sha1","hmac-sha256","hmac-sha512"],"items":{"type":"string","enum":["hmac-sha1","hmac-sha256","hmac-sha512"]},"minItems":1},"_meta":{"type":"object","properties":{"filter":{"description":"filter
determines whether the plugin needs to be executed at
runtime","type":"array"},"error_response":{"oneOf":[{"t [...]
]]
)
ngx.status = code
