Skip to content

Commit 3c18adf

Browse files
fredbiclaude
andcommitted
docs(spec): correct stale externalDocs comment in meta walker
The comment claimed externalDocs on route/operation/schema was a pending "separate feature (§9)". That work has landed — operation/schema emit via their own builders and per-tag externalDocs rides the KwTags []spec.Tag unmarshal (locked by TestCoverage_Bug2655). Update the comment to describe where each host object's externalDocs is actually emitted. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
1 parent b67c2e0 commit 3c18adf

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

‎internal/builders/spec/walker.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,10 @@ func dispatchMetaSimple(p grammar.Property, swspec *spec.Swagger) bool {
116116
// ride grammar's typed Extensions surface (see applyMetaBlock —
117117
// the block.Extensions() loop routes each entry by ext.Source).
118118
//
119-
// externalDocs is wired for swagger:meta only (top-level
120-
// spec.ExternalDocs); the keyword is also grammar-legal on
121-
// route/operation/schema, but emitting it there is a separate feature
122-
// (forthcoming-features.md §9).
119+
// The KwExternalDocs arm here sets the top-level spec.ExternalDocs for
120+
// swagger:meta. The same keyword on route/operation/schema is emitted
121+
// by their own builders (routes/walker.go, handlers.schemaRawHandler),
122+
// and per-tag externalDocs rides the KwTags []spec.Tag unmarshal below.
123123
func dispatchMetaYAMLBlock(p grammar.Property, swspec *spec.Swagger) error {
124124
switch p.Keyword.Name {
125125
case grammar.KwSecurityDefinitions:

0 commit comments

Comments
 (0)
⌂ 换网址