Skip to content

fix: Unexpected reference depth oapi-codegen#1348 #1950

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

Draft
moemoequte wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

fix: Unexpected reference depth oapi-codegen#1348 #1950

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c775a79
Remove checks for `unexpected reference depth`
jamietanna Dec 18, 2023
2327423
Add test case for reference depth checks
jamietanna Dec 18, 2023
936ca06
rew! WIP: add a `jsonLookup` method
jamietanna Dec 19, 2023
cb50572
WIP-wire
jamietanna Dec 19, 2023
87bdd54
WIP
jamietanna Dec 19, 2023
d1bf3b3
fix: Unexpected reference depth #1348
moemoequte Apr 14, 2025
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
70 changes: 69 additions & 1 deletion pkg/codegen/utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import (
"unicode"

"github.com/getkin/kin-openapi/openapi3"
"github.com/go-openapi/jsonpointer"
)

var (
Expand Down Expand Up @@ -446,7 +447,46 @@ func RefPathToGoType(refPath string) (string, error) {
// refPathToGoType returns the Go typename for refPath given its
func refPathToGoType(refPath string, local bool) (string, error) {
if refPath[0] == '#' {
return refPathToGoTypeSelf(refPath, local)
pathParts := strings.Split(refPath, "/")

t, err := jsonLookup(globalState.spec, refPath)
if err != nil {
fmt.Printf("err: %v\n", err)
}
// fmt.Printf("t: %v\n", t)
// fmt.Printf("t: %#v\n", t)

schema, ok := t.(*openapi3.Schema)
if ok {
var s Schema
// if schema.Type == "string" {
// return "string", nil
// }
fmt.Printf("s: %#v\n", s)
fmt.Printf("oapiSchemaToGoType(schema, nil, &s): %v\n", oapiSchemaToGoType(schema, nil, &s))
fmt.Printf("s: %v\n", s)
if schema.Type.Includes("object") {
err = oapiSchemaToGoType(schema, nil, &s)
if err != nil {
return "", err // TODO
}
return s.GoType, nil
}
}

// Schemas may have been renamed locally, so look up the actual name in
// the spec.
name, err := findSchemaNameByRefPath(refPath, globalState.spec)
if err != nil {
return "", fmt.Errorf("error finding ref: %s in spec: %v", refPath, err)
}
if name != "" {
return name, nil
}
// lastPart now stores the final element of the type path. This is what
// we use as the base for a type name.
lastPart := pathParts[len(pathParts)-1]
return SchemaNameToTypeName(lastPart), nil
}
pathParts := strings.Split(refPath, "#")
if len(pathParts) != 2 {
Expand Down Expand Up @@ -1104,3 +1144,31 @@ func sliceContains[E comparable](s []E, v E) bool {
}
return false
}

// jsonLookup allows taking a JSON pointer and looking up the value present at the given OpenAPI specification at that path.
func jsonLookup(spec *openapi3.T, ref string) (any, error) {
parts := strings.Split(ref, "/")

var pointed any // TODO doc
pointed = spec

// fmt.Println(jsonpointer.GetForToken(spec, parts[1]))
for i, v := range parts {
if i == 0 {
if v != "#" {
return nil, fmt.Errorf("TODO: %v", v)
}

continue
}

t, _, err := jsonpointer.GetForToken(pointed, v)
if err != nil {
return nil, err // TODO
}

pointed = t
}

return pointed, nil
}