fix(swagger): add example field to path/form/header parameters (#5497)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
kesonan
2026-03-21 23:18:55 +08:00
committed by GitHub
parent 04ed637366
commit eb2302b71e
4 changed files with 154 additions and 0 deletions

View File

@@ -0,0 +1,34 @@
syntax = "v1"
info (
title: "Issue 5496 Reproduce"
version: "v1"
host: "localhost"
)
// Reproduces issue #5496:
// The `example` tag option in `path` and `form` tags does not appear in generated swagger JSON.
type (
Request {
// path param with example — should appear as example in swagger
Name string `path:"name,options=you|me,example=nihao"`
// form param with example and range — should appear as example in swagger
Age int `form:"age,optional,range=[1:200],example=18"`
}
Response {
Name string `json:"name,example=nihao"`
Age int `json:"age,example=18"`
}
)
@server (
tags: "issue5496"
summary: "Issue 5496 - example field missing for path/form params"
)
service issue5496 {
@doc (
description: "Demonstrate that example is missing in path/form swagger params"
)
@handler getUser
get /user/:name (Request) returns (Response)
}