Skip to content

Qualify external header schema refs in generated response headers #2463

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
mromaszewicz merged 1 commit into from
Jul 13, 2026
Merged

Qualify external header schema refs in generated response headers #2463

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
17 changes: 17 additions & 0 deletions internal/test/references/multipackage/header_ref/common/spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# From issue-2060: common spec providing an externally referenced header whose
# schema is a $ref to a named type in this same package.
openapi: "3.0.4"
info:
title: Common
version: "0.0.1"
paths: {}
components:
schemas:
ETagSchema:
type: string
description: RFC 7232 entity tag
headers:
ETag:
description: Entity tag header
schema:
$ref: "#/components/schemas/ETagSchema"
12 changes: 12 additions & 0 deletions internal/test/references/multipackage/header_ref/config.api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# yaml-language-server: $schema=../../../../../configuration-schema.json
package: api
generate:
chi-server: true
strict-server: true
client: true
models: true
import-mapping:
./common/spec.yaml: github.com/oapi-codegen/oapi-codegen/v2/internal/test/references/multipackage/header_ref/gen/common
output: gen/api/api.gen.go
output-options:
skip-prune: true
7 changes: 7 additions & 0 deletions internal/test/references/multipackage/header_ref/config.common.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# yaml-language-server: $schema=../../../../../configuration-schema.json
package: common
generate:
models: true
output: gen/common/common.gen.go
output-options:
skip-prune: true
11 changes: 11 additions & 0 deletions internal/test/references/multipackage/header_ref/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
// Package headerref is a regression test for issue-2060: a response header
// that is an external `$ref` whose schema is itself a `$ref` to a named type
// must qualify that type with the imported package (e.g.
// externalRef0.ETagSchema), both in the strict-server response headers struct
// and in the typed client response wrappers. Before the fix the header field
// referenced an undefined local type and the generated package failed to
// compile.
package headerref

//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen --config=config.common.yaml common/spec.yaml
//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen --config=config.api.yaml spec.yaml
Loading