Prefer less-known field tags to json when deciding on param content type (#70)

Author: vearutop

openapi3/example_test.go

@@ -514,7 +514,7 @@ func ExampleReflector_SetRequest_queryObject() {
 		Quux   float64 `query:"quux"`
 		Deeper struct {
 			Val string `query:"val"`
-		} `json:"deeper"`
+		} `query:"deeper"`
 	}
 
 	type req struct {
@@ -559,12 +559,12 @@ func ExampleReflector_SetRequest_queryObject() {
 	//               $ref: '#/components/schemas/QueryOpenapi3TestJsonFilter'
 	//         in: query
 	//         name: json_filter
-	//       - content:
-	//           application/json:
-	//             schema:
-	//               $ref: '#/components/schemas/QueryOpenapi3TestDeepObjectFilter'
+	//       - explode: true
 	//         in: query
 	//         name: deep_object_filter
+	//         schema:
+	//           $ref: '#/components/schemas/QueryOpenapi3TestDeepObjectFilter'
+	//         style: deepObject
 	//       - in: path
 	//         name: id
 	//         required: true
@@ -578,9 +578,15 @@ func ExampleReflector_SetRequest_queryObject() {
 	//   schemas:
 	//     QueryOpenapi3TestDeepObjectFilter:
 	//       properties:
+	//         baz:
+	//           type: boolean
 	//         deeper:
-	//           nullable: true
+	//           properties:
+	//             val:
+	//               type: string
 	//           type: object
+	//         quux:
+	//           type: number
 	//       type: object
 	//     QueryOpenapi3TestJsonFilter:
 	//       properties:

openapi3/reflect.go

@@ -309,7 +309,7 @@ func (r *Reflector) parseParametersIn(
 
 			// Check if parameter is an JSON encoded object.
 			property := reflect.New(field.Type).Interface()
-			if refl.HasTaggedFields(property, tagJSON) {
+			if refl.HasTaggedFields(property, tagJSON) && !refl.HasTaggedFields(property, string(in)) {
 				propertySchema, err := r.Reflect(property,
 					r.withOperation(oc, false, string(in)),
 					jsonschema.DefinitionsPrefix(definitionsPrefix),

openapi3/reflect_test.go

@@ -878,6 +878,8 @@ func TestReflector_SetupRequest_form_only(t *testing.T) {
 func TestReflector_SetRequest_queryObject(t *testing.T) {
 	reflector := openapi3.Reflector{}
 
+	// JSON object is only enabled when at least one `json` tag is available on top-level property,
+	// and there are no `in` tags, e.g. `query`.
 	type jsonFilter struct {
 		Foo    string `json:"foo"`
 		Bar    int    `json:"bar"`
@@ -886,9 +888,11 @@ func TestReflector_SetRequest_queryObject(t *testing.T) {
 		} `json:"deeper"`
 	}
 
+	// Deep object structure may have `json` tags, they are ignored in presence of
+	// at least one top-level field with a matching `in` tag, e.g. `query`.
 	type deepObjectFilter struct {
-		Baz    bool    `query:"baz"`
-		Quux   float64 `query:"quux"`
+		Baz    bool    `json:"baz" query:"baz"`
+		Quux   float64 `json:"quux" query:"quux"`
 		Deeper struct {
 			Val string `query:"val"`
 		} `query:"deeper"`