Improve HttpQueryParams validator message

smithy-model/src/main/java/software/amazon/smithy/model/validation/validators/HttpQueryParamsTraitValidator.java

@@ -21,10 +21,13 @@
 import software.amazon.smithy.model.Model;
 import software.amazon.smithy.model.shapes.MemberShape;
 import software.amazon.smithy.model.shapes.Shape;
+import software.amazon.smithy.model.shapes.StructureShape;
 import software.amazon.smithy.model.traits.HttpQueryParamsTrait;
 import software.amazon.smithy.model.traits.HttpQueryTrait;
+import software.amazon.smithy.model.traits.Trait;
 import software.amazon.smithy.model.validation.AbstractValidator;
 import software.amazon.smithy.model.validation.ValidationEvent;
+import software.amazon.smithy.model.validation.ValidationUtils;
 
 /**
  * When the `httpQueryParams` trait is used, this validator emits a NOTE when another member of the container shape
@@ -47,15 +50,31 @@ private List<ValidationEvent> validateQueryTraitUsage(Model model) {
             shape.asMemberShape().flatMap(member -> model.getShape(member.getContainer())
                 .flatMap(Shape::asStructureShape))
                 .ifPresent(structure -> {
-                    for (MemberShape memberShape : structure.members()) {
-                        if (memberShape.hasTrait(HttpQueryTrait.class)) {
-                            events.add(note(shape, String.format("Trait `httpQueryParams` may potentially conflict with"
-                                    + " `httpQuery` trait applied to `%s`.", memberShape.toShapeId())));
-                        }
+                    // Gather the names of member shapes, as strings, that apply HttpQuery traits
+                    List<String> queryShapes = getMembersWithTrait(structure, HttpQueryTrait.class);
+                    if (queryShapes.size() > 0) {
+                        events.add(createNote(structure, shape.toShapeId().getMember().get(), queryShapes));
                     }
                 });
         }
 
         return events;
     }
+
+    private List<String> getMembersWithTrait(StructureShape structure, Class<? extends Trait> trait) {
+        List<String> members = new ArrayList<>();
+        for (MemberShape member : structure.members()) {
+            if (member.hasTrait(trait)) {
+                members.add(member.getMemberName());
+            }
+        }
+        return members;
+    }
+
+    private ValidationEvent createNote(Shape target, String queryParamsShape, List<String> queryShapes) {
+        return note(target, String.format("Operation input `%s` has an `httpQueryParams` trait applied to the `%s` "
+                + "member and `httpQuery` traits applied to the following members: %s. This can cause confusion when "
+                + "keys from the `httpQueryParams` trait conflict with those defined directly by `httpQuery` traits",
+                target.toShapeId(), queryParamsShape, ValidationUtils.tickedList(queryShapes)));
+    }
 }

smithy-model/src/test/resources/software/amazon/smithy/model/errorfiles/validators/http-request-response-validator.errors

@@ -29,4 +29,4 @@
 [ERROR] ns.foo#HInput$a: Trait `httpHeader` cannot be applied to `ns.foo#HInput$a`. This trait may only be applied to shapes that match the following selector: structure > :test(member > :test(boolean, number, string, timestamp, collection > member > :test(boolean, number, string, timestamp))) | TraitTarget
 [ERROR] ns.foo#EInput$label2: Trait `httpLabel` cannot be applied to `ns.foo#EInput$label2`. This trait may only be applied to shapes that match the following selector: structure > member[trait|required] :test(> :test(string, number, boolean, timestamp)) | TraitTarget
 [ERROR] ns.foo#OInput$a: Trait `httpLabel` cannot be applied to `ns.foo#OInput$a`. This trait may only be applied to shapes that match the following selector: structure > member[trait|required] :test(> :test(string, number, boolean, timestamp)) | TraitTarget
-[NOTE] ns.foo#QueryParamsInput$queryParams: Trait `httpQueryParams` may potentially conflict with `httpQuery` trait applied to `ns.foo#QueryParamsInput$namedQuery`. | HttpQueryParamsTrait
+[NOTE] ns.foo#QueryParamsInput: Operation input `ns.foo#QueryParamsInput` has an `httpQueryParams` trait applied to the `queryParams` member and `httpQuery` traits applied to the following members: `namedQuery`, `otherNamedQuery`. This can cause confusion when keys from the `httpQueryParams` trait conflict with those defined directly by `httpQuery` traits | HttpQueryParamsTrait

smithy-model/src/test/resources/software/amazon/smithy/model/errorfiles/validators/http-request-response-validator.json

@@ -754,6 +754,12 @@
                         "smithy.api#httpQuery": "named"
                     }
                 },
+                "otherNamedQuery": {
+                    "target": "ns.foo#String",
+                    "traits": {
+                        "smithy.api#httpQuery": "otherNamed"
+                    }
+                },
                 "queryParams": {
                     "target": "ns.foo#MapOfString",
                     "traits": {