Add help text to ResourceOperationInputOutput event

smithy-lang · Dec 19, 2024 · 50eb16d · 50eb16d
1 parent 43486ae
commit 50eb16d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/...ware/amazon/smithy/model/validation/validators/ResourceOperationInputOutputValidator.java b/...ware/amazon/smithy/model/validation/validators/ResourceOperationInputOutputValidator.java
@@ -33,6 +33,9 @@
 import software.amazon.smithy.model.shapes.ResourceShape;
 import software.amazon.smithy.model.shapes.Shape;
 import software.amazon.smithy.model.shapes.ShapeId;
+import software.amazon.smithy.model.traits.NotPropertyTrait;
+import software.amazon.smithy.model.traits.PropertyTrait;
+import software.amazon.smithy.model.traits.ResourceIdentifierTrait;
 import software.amazon.smithy.model.validation.AbstractValidator;
 import software.amazon.smithy.model.validation.ValidationEvent;
 
@@ -214,8 +217,10 @@ private void validateMember(
                         resource.getId(), propertyName)));
             }
         } else if (!identifierMembers.contains(member.getMemberName())) {
-            events.add(error(member, String.format("Member `%s` does not target a property or identifier"
-                    + " for resource `%s`", member.getMemberName(), resource.getId().toString())));
+            events.add(error(member, String.format("Member `%s` does not target a property or identifier for resource "
+                    + "`%s`. If it is an identifier, apply the `%s` trait. If it is a property, apply the `%s` trait. "
+                    + "If it is neither, apply the `%s` trait.", member.getMemberName(), resource.getId().toString(),
+                    ResourceIdentifierTrait.ID, PropertyTrait.ID, NotPropertyTrait.ID)));
         }
     }
 }
diff --git a/...n/smithy/model/errorfiles/validators/resource-properties/invalid-output-identifier.errors b/...n/smithy/model/errorfiles/validators/resource-properties/invalid-output-identifier.errors
@@ -1 +1 @@
-[ERROR] com.example#CreateResourceOutput$id: Member `id` does not target a property or identifier for resource `com.example#Resource1` | ResourceOperationInputOutput
+[ERROR] com.example#CreateResourceOutput$id: Member `id` does not target a property or identifier for resource `com.example#Resource1`. If it is an identifier, apply the `smithy.api#resourceIdentifier` trait. If it is a property, apply the `smithy.api#property` trait. If it is neither, apply the `smithy.api#notProperty` trait. | ResourceOperationInputOutput
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		[ERROR] com.example#CreateResourceOutput$id: Member `id` does not target a property or identifier for resource `com.example#Resource1` \| ResourceOperationInputOutput
		[ERROR] com.example#CreateResourceOutput$id: Member `id` does not target a property or identifier for resource `com.example#Resource1`. If it is an identifier, apply the `smithy.api#resourceIdentifier` trait. If it is a property, apply the `smithy.api#property` trait. If it is neither, apply the `smithy.api#notProperty` trait. \| ResourceOperationInputOutput