Resolve PR Comments

IntelliTect · Aug 12, 2024 · 5d67c9a · 5d67c9a
1 parent 60485ea
commit 5d67c9a
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 35 deletions.
diff --git a/docs/modeling/model-components/attributes.md b/docs/modeling/model-components/attributes.md
@@ -21,7 +21,7 @@ The displayed name and description of a property, as well as the order in which
 The displayed name of a property can also be set via the `[DisplayName]` attribute.
 
 ### [Description]
-The description of a class.
+The description of a type, such as a class, property, method, or parameter.
 
 ### [Required]
 

diff --git a/playground/Coalesce.Web.Vue3/src/metadata.g.ts b/playground/Coalesce.Web.Vue3/src/metadata.g.ts
diff --git a/src/IntelliTect.Coalesce.CodeGeneration.Vue/Generators/Scripts/TsMetadata.cs b/src/IntelliTect.Coalesce.CodeGeneration.Vue/Generators/Scripts/TsMetadata.cs
@@ -102,8 +102,15 @@ private void WriteCommonClassMetadata(TypeScriptCodeBuilder b, ClassViewModel mo
         {
             b.StringProp("name", model.ClientTypeName);
             b.StringProp("displayName", model.DisplayName);
-            b.StringProp("description", model.GetAttributeValue<DescriptionAttribute>(a => a.Description));
-
+
+            var description = model.GetAttributeValue<DescriptionAttribute>(a => a.Description)
+                ?? model.GetAttributeValue<DisplayAttribute>(a => a.Description);
+
+            if (!string.IsNullOrWhiteSpace(description))
+            {
+                b.StringProp("description", description);
+            }
+
             if (model.ListTextProperty != null)
             {
                 // This might not be defined for external types, because sometimes it just doesn't make sense. We'll accommodate on the client.

diff --git a/src/coalesce-vue/src/metadata.ts b/src/coalesce-vue/src/metadata.ts
@@ -151,7 +151,6 @@ export interface ModelType extends CustomReferenceTypeBase, ApiRoutedType {
 export interface DataSourceType extends Metadata {
   readonly type: "dataSource";
   readonly isDefault?: true;
-  readonly description?: string;
 
   /** The parameters of the data source.
    * Stored as `props` so it can be treated like a ModelType/ObjectType in many cases.