Skip to content
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

Jump to bottom

Make external ref internalization optional #840

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Make external ref internalization optional #840

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db75df1
Make external ref internalization optional
kkroo Nov 7, 2022
28e7aaf
Apply suggestions from code review
kkroo Nov 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 5 additions & 1 deletion pkg/codegen/codegen.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,12 @@ func Generate(spec *openapi3.T, opts Configuration) (string, error) {
}

var inlinedSpec string
var refNameResolver openapi3.RefNameResolver
if opts.OutputOptions.InternalizeRefs {
refNameResolver = openapi3.DefaultRefNameResolver
}
kkroo marked this conversation as resolved.
Show resolved Hide resolved
if opts.Generate.EmbeddedSpec {
inlinedSpec, err = GenerateInlinedSpec(t, importMapping, spec)
inlinedSpec, err = GenerateInlinedSpec(t, importMapping, spec, refNameResolver)
kkroo marked this conversation as resolved.
Show resolved Hide resolved
if err != nil {
return "", fmt.Errorf("error generating Go handlers for Paths: %w", err)
}
Expand Down
1 change: 1 addition & 0 deletions pkg/codegen/configuration.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ type OutputOptions struct {
ExcludeSchemas []string `yaml:"exclude-schemas,omitempty"` // Exclude from generation schemas with given names. Ignored when empty.
ResponseTypeSuffix string `yaml:"response-type-suffix,omitempty"` // The suffix used for responses types
ClientTypeName string `yaml:"client-type-name,omitempty"` // Override the default generated client type with the value
InternalizeRefs bool `yaml:"internalize-refs,omitempty"` // Internalize external $ref types
}

// UpdateDefaults sets reasonable default values for unset fields in Configuration
Expand Down
6 changes: 4 additions & 2 deletions pkg/codegen/inline.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,11 @@ import (

// GenerateInlinedSpec generates a gzipped, base64 encoded JSON representation of the
// swagger definition, which we embed inside the generated code.
func GenerateInlinedSpec(t *template.Template, importMapping importMap, swagger *openapi3.T) (string, error) {
func GenerateInlinedSpec(t *template.Template, importMapping importMap, swagger *openapi3.T, refNameResolver openapi3.RefNameResolver) (string, error) {
kkroo marked this conversation as resolved.
Show resolved Hide resolved
// ensure that any external file references are embedded into the embedded spec
swagger.InternalizeRefs(context.Background(), nil)
if refNameResolver != nil {
swagger.InternalizeRefs(context.Background(), refNameResolver)
}
kkroo marked this conversation as resolved.
Show resolved Hide resolved
// Marshal to json
encoded, err := swagger.MarshalJSON()
if err != nil {
Expand Down