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

Fix support for jsonschema.Struct in requests #110

Merged
merged 2 commits into from
May 20, 2024
Merged

Fix support for jsonschema.Struct in requests #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37b853f
Fix support for jsonschema.Struct in requests
vearutop May 20, 2024
95054a7
Fix lint
vearutop May 20, 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
12 changes: 10 additions & 2 deletions internal/json_schema.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,14 @@
hasTaggedFields = refl.HasTaggedFields(input, t)
}

hasJSONSchemaStruct := false

refl.WalkFieldsRecursively(reflect.ValueOf(input), func(v reflect.Value, _ reflect.StructField, _ []reflect.StructField) {
if v.Type() == reflect.TypeOf(jsonschema.Struct{}) {
hasJSONSchemaStruct = true
}

Check notice on line 74 in internal/json_schema.go

View workflow job for this annotation

GitHub Actions / test (1.22.x) 

5 statement(s) are not covered by tests.
})

// Form data can not have map or array as body.
if !hasTaggedFields && len(mapping) == 0 && tag != tagJSON {
return nil, false, nil
Expand All @@ -74,7 +82,7 @@
// If `formData` is defined on a request body `json` is ignored.
if tag == tagJSON &&
(refl.HasTaggedFields(input, tagFormData) || refl.HasTaggedFields(input, tagForm)) &&
!forceJSONRequestBody {
!forceJSONRequestBody && !hasJSONSchemaStruct {

Check notice on line 85 in internal/json_schema.go

View workflow job for this annotation

GitHub Actions / test (1.22.x) 

2 statement(s) on lines 83:87 are not covered by tests.
return nil, false, nil
}

Expand All @@ -89,7 +97,7 @@
}

// JSON can be a map or array without field tags.
if !hasTaggedFields && len(mapping) == 0 && !refl.IsSliceOrMap(input) &&
if !hasTaggedFields && !hasJSONSchemaStruct && len(mapping) == 0 && !refl.IsSliceOrMap(input) &&

Check notice on line 100 in internal/json_schema.go

View workflow job for this annotation

GitHub Actions / test (1.22.x) 

1 statement(s) on lines 100:101 are not covered by tests.
refl.FindEmbeddedSliceOrMap(input) == nil && !isProcessWithoutTags {
return nil, false, nil
}
Expand Down
86 changes: 86 additions & 0 deletions openapi3/reflect_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1123,3 +1123,89 @@ func TestReflector_AddOperation_defName(t *testing.T) {
}
}`, r.Spec)
}

func TestReflector_AddOperation_jsonschemaStruct(t *testing.T) {
r := openapi3.NewReflector()

oc, err := r.NewOperationContext(http.MethodPost, "/foo/{id}")
require.NoError(t, err)

type Req struct {
ID int `path:"id"`
jsonschema.Struct
}

req := Req{}
req.DefName = "FooStruct"
req.Fields = append(req.Fields, jsonschema.Field{
Name: "Foo",
Value: "abc",
Tag: `json:"foo" minLength:"3"`,
})

type Resp struct {
ID int `json:"id"`
jsonschema.Struct
Nested jsonschema.Struct `json:"nested"`
}

resp := Resp{}
resp.DefName = "BarStruct"
resp.Fields = append(resp.Fields, jsonschema.Field{
Name: "Bar",
Value: "cba",
Tag: `json:"bar" maxLength:"3"`,
})
resp.Nested.DefName = "BazStruct"
resp.Nested.Fields = append(resp.Nested.Fields, jsonschema.Field{
Name: "Baz",
Value: "def",
Tag: `json:"baz" maxLength:"5"`,
})

oc.AddReqStructure(req)
oc.AddRespStructure(resp)

require.NoError(t, r.AddOperation(oc))

assertjson.EqMarshal(t, `{
"openapi":"3.0.3","info":{"title":"","version":""},
"paths":{
"/foo/{id}":{
"post":{
"parameters":[
{
"name":"id","in":"path","required":true,"schema":{"type":"integer"}
}
],
"requestBody":{
"content":{
"application/json":{"schema":{"$ref":"#/components/schemas/FooStruct"}}
}
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{"schema":{"$ref":"#/components/schemas/BarStruct"}}
}
}
}
}
}
},
"components":{
"schemas":{
"BarStruct":{
"properties":{
"bar":{"maxLength":3,"type":"string"},"id":{"type":"integer"},
"nested":{"$ref":"#/components/schemas/BazStruct"}
},
"type":"object"
},
"BazStruct":{"properties":{"baz":{"maxLength":5,"type":"string"}},"type":"object"},
"FooStruct":{"properties":{"foo":{"minLength":3,"type":"string"}},"type":"object"}
}
}
}`, r.SpecSchema())
}
86 changes: 86 additions & 0 deletions openapi31/reflect_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1251,3 +1251,89 @@ func TestReflector_AddOperation_rawSchema(t *testing.T) {
}
}`, r.SpecSchema())
}

func TestReflector_AddOperation_jsonschemaStruct(t *testing.T) {
r := openapi31.NewReflector()

oc, err := r.NewOperationContext(http.MethodPost, "/foo/{id}")
require.NoError(t, err)

type Req struct {
ID int `path:"id"`
jsonschema.Struct
}

req := Req{}
req.DefName = "FooStruct"
req.Fields = append(req.Fields, jsonschema.Field{
Name: "Foo",
Value: "abc",
Tag: `json:"foo" minLength:"3"`,
})

type Resp struct {
ID int `json:"id"`
jsonschema.Struct
Nested jsonschema.Struct `json:"nested"`
}

resp := Resp{}
resp.DefName = "BarStruct"
resp.Fields = append(resp.Fields, jsonschema.Field{
Name: "Bar",
Value: "cba",
Tag: `json:"bar" maxLength:"3"`,
})
resp.Nested.DefName = "BazStruct"
resp.Nested.Fields = append(resp.Nested.Fields, jsonschema.Field{
Name: "Baz",
Value: "def",
Tag: `json:"baz" maxLength:"5"`,
})

oc.AddReqStructure(req)
oc.AddRespStructure(resp)

require.NoError(t, r.AddOperation(oc))

assertjson.EqMarshal(t, `{
"openapi":"3.1.0","info":{"title":"","version":""},
"paths":{
"/foo/{id}":{
"post":{
"parameters":[
{
"name":"id","in":"path","required":true,"schema":{"type":"integer"}
}
],
"requestBody":{
"content":{
"application/json":{"schema":{"$ref":"#/components/schemas/FooStruct"}}
}
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{"schema":{"$ref":"#/components/schemas/BarStruct"}}
}
}
}
}
}
},
"components":{
"schemas":{
"BarStruct":{
"properties":{
"bar":{"maxLength":3,"type":"string"},"id":{"type":"integer"},
"nested":{"$ref":"#/components/schemas/BazStruct"}
},
"type":"object"
},
"BazStruct":{"properties":{"baz":{"maxLength":5,"type":"string"}},"type":"object"},
"FooStruct":{"properties":{"foo":{"minLength":3,"type":"string"}},"type":"object"}
}
}
}`, r.SpecSchema())
}
Loading