Skip to content

feat: add support for using package name for external ref imports #2193

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

Closed
InventivetalentDev wants to merge 6 commits into from
Closed

feat: add support for using package name for external ref imports #2193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d874d23
support using package name for external refs
InventivetalentDev Feb 1, 2026
7e6ced1
rename
InventivetalentDev Feb 2, 2026
4a806be
stick with snake_case
InventivetalentDev Feb 2, 2026
4cd769f
copy test
InventivetalentDev Feb 2, 2026
1620939
another test
InventivetalentDev Feb 2, 2026
04a29f0
Merge branch 'main' into feat/external-ref
InventivetalentDev Feb 10, 2026
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
3 changes: 3 additions & 0 deletions internal/test/externalref_named/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package externalref_named

//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen --config=externalref.cfg.yaml spec.yaml
13 changes: 13 additions & 0 deletions internal/test/externalref_named/externalref.cfg.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# yaml-language-server: $schema=../../../configuration-schema.json
package: externalref_named
generate:
models: true
embedded-spec: true
external-ref-named-imports: true
import-mapping:
./packageA/spec.yaml: github.com/oapi-codegen/oapi-codegen/v2/internal/test/externalref_named/packageA
./packageB/spec.yaml: github.com/oapi-codegen/oapi-codegen/v2/internal/test/externalref_named/packageB
https://petstore3.swagger.io/api/v3/openapi.json: github.com/oapi-codegen/oapi-codegen/v2/internal/test/externalref_named/petstore
output: externalref.gen.go
output-options:
skip-prune: true
130 changes: 130 additions & 0 deletions internal/test/externalref_named/externalref.gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

32 changes: 32 additions & 0 deletions internal/test/externalref_named/imports_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
package externalref_named

import (
"testing"

packageA "github.com/oapi-codegen/oapi-codegen/v2/internal/test/externalref_named/packageA"
packageB "github.com/oapi-codegen/oapi-codegen/v2/internal/test/externalref_named/packageB"
petstore "github.com/oapi-codegen/oapi-codegen/v2/internal/test/externalref_named/petstore"
"github.com/stretchr/testify/require"
)

func TestParameters(t *testing.T) {
b := &packageB.ObjectB{}
_ = Container{
ObjectA: &packageA.ObjectA{ObjectB: b},
ObjectB: b,
}
}

func TestGetSwagger(t *testing.T) {
_, err := packageB.GetSwagger()
require.Nil(t, err)

_, err = packageA.GetSwagger()
require.Nil(t, err)

_, err = petstore.GetSwagger()
require.Nil(t, err)

_, err = GetSwagger()
require.Nil(t, err)
}
5 changes: 5 additions & 0 deletions internal/test/externalref_named/object_c.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"type": "object",
"properties": {},
"additionalProperties": true
}
11 changes: 11 additions & 0 deletions internal/test/externalref_named/packageA/config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# yaml-language-server: $schema=../../../../configuration-schema.json
package: packagea
generate:
models: true
embedded-spec: true
external-ref-named-imports: true
output-options:
skip-prune: true
import-mapping:
../packageB/spec.yaml: github.com/oapi-codegen/oapi-codegen/v2/internal/test/externalref_named/packageB
output: externalref.gen.go
3 changes: 3 additions & 0 deletions internal/test/externalref_named/packageA/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package packagea

//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen --config=config.yaml spec.yaml
109 changes: 109 additions & 0 deletions internal/test/externalref_named/packageA/externalref.gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions internal/test/externalref_named/packageA/spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
components:
schemas:
ObjectA:
properties:
name:
type: string
object_b:
$ref: ../packageB/spec.yaml#/components/schemas/ObjectB
9 changes: 9 additions & 0 deletions internal/test/externalref_named/packageB/config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# yaml-language-server: $schema=../../../../configuration-schema.json
package: packageb
generate:
models: true
embedded-spec: true
external-ref-named-imports: true
output-options:
skip-prune: true
output: externalref.gen.go
3 changes: 3 additions & 0 deletions internal/test/externalref_named/packageB/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package packageb

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