这是indexloc提供的服务，不要输入任何密码
Skip to content

fix(schema): add dereferencing for SchemaFromType #518

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
merged 3 commits into from
Jul 25, 2024
Merged

fix(schema): add dereferencing for SchemaFromType #518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8065a91
fix(schema): add dereferencing for SchemaFromType
superstas Jul 23, 2024
5d90e4f
Merge branch 'main' into fix/missed-description-with-ptr
danielgtaylor Jul 25, 2024
c27510d
test: fix missing limits in test
danielgtaylor Jul 25, 2024
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
2 changes: 2 additions & 0 deletions schema.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -658,6 +658,8 @@ type SchemaTransformer interface {
// schema := huma.SchemaFromType(registry, reflect.TypeOf(MyType{}))
func SchemaFromType(r Registry, t reflect.Type) *Schema {
s := schemaFromType(r, t)
t = deref(t)

// Transform generated schema if type implements SchemaTransformer
v := reflect.New(t).Interface()
if st, ok := v.(SchemaTransformer); ok {
Expand Down
34 changes: 29 additions & 5 deletions schema_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,17 @@ func (t *TypedArrayWithCustomDesc) TransformSchema(r huma.Registry, s *huma.Sche
return s
}

var _ huma.SchemaTransformer = (*CustomSchemaPtr)(nil)

type CustomSchemaPtr struct {
Value string `json:"value"`
}

func (c *CustomSchemaPtr) TransformSchema(r huma.Registry, s *huma.Schema) *huma.Schema {
s.Description = "custom description"
return s
}

type TypedStringWithCustomLength string

func (c TypedStringWithCustomLength) Schema(r huma.Registry) *huma.Schema {
Expand Down Expand Up @@ -1005,7 +1016,9 @@ func TestSchema(t *testing.T) {
"properties":{
"value":{
"format":"int64",
"type": ["integer", "null"]
"type": ["integer", "null"],
"minimum":1,
"maximum":10
}
},
"required":["value"],
Expand Down Expand Up @@ -1058,6 +1071,21 @@ func TestSchema(t *testing.T) {
"type":"object"
}`,
},
{
name: "schema-transformer-for-ptr",
input: &CustomSchemaPtr{},
expected: ` {
"additionalProperties":false,
"description":"custom description",
"properties":{
"value":{
"type":"string"
}
},
"required":["value"],
"type":"object"
}`,
},
}

for _, c := range cases {
Expand Down Expand Up @@ -1098,7 +1126,6 @@ func TestSchemaOld(t *testing.T) {
r := huma.NewMapRegistry("#/components/schemas/", huma.DefaultSchemaNamer)

s := r.Schema(reflect.TypeOf(GreetingInput{}), false, "")
// fmt.Printf("%+v\n", s)
assert.Equal(t, "object", s.Type)
assert.Len(t, s.Properties, 1)
assert.Equal(t, "string", s.Properties["ID"].Type)
Expand All @@ -1115,9 +1142,6 @@ func TestSchemaOld(t *testing.T) {
},
}, &res)
assert.Empty(t, res.Errors)

// b, _ := json.MarshalIndent(r.Map(), "", " ")
// fmt.Println(string(b))
}

func TestSchemaGenericNaming(t *testing.T) {
Expand Down