SP-397: include description in asset-registry list output

docs/user-guide/asset-registry-commands.md

@@ -14,10 +14,12 @@ content-cli asset-registry list
 Example output:
 
 ```
-BOARD_V2 - View [DASHBOARDS] (basePath: /blueprint/api)
-SEMANTIC_MODEL - Knowledge Model [DATA_AND_PROCESS_MODELING] (basePath: /semantic-layer/api)
+BOARD_V2 - View [DASHBOARDS]
+SEMANTIC_MODEL - Knowledge Model [DATA_AND_PROCESS_MODELING] - Defines KPIs, records, filters, and data bindings for analytics
 ```
 
+Each line is `<assetType> - <displayName> [<group>]` followed by ` - <description>` when the asset type provides one.
+
 It is also possible to use the `--json` option for writing the full response to a file that gets created in the working directory.
 
 ```

src/commands/asset-registry/asset-registry.service.ts

@@ -131,9 +131,12 @@ export class AssetRegistryService {
     }
 
     private logDescriptorSummary(descriptor: AssetRegistryDescriptor): void {
-        logger.info(
-            `${descriptor.assetType} - ${descriptor.displayName} [${descriptor.group}]`
-        );
+        const base = `${descriptor.assetType} - ${descriptor.displayName} [${descriptor.group}]`;
+        if (descriptor.description) {
+            logger.info(`${base} - ${descriptor.description}`);
+        } else {
+            logger.info(base);
+        }
     }
 
     private logDescriptorDetail(descriptor: AssetRegistryDescriptor): void {

tests/commands/asset-registry/asset-registry-list.spec.ts

@@ -42,17 +42,44 @@ describe("Asset registry list", () => {
         },
     };
 
-    it("Should list all asset types", async () => {
-        mockAxiosGet("https://myTeam.celonis.cloud/pacman/api/core/asset-registry/types", metadata);
+    it("Should render the description when it is present", async () => {
+        const withDescription: AssetRegistryMetadata = {
+            types: {
+                SEMANTIC_MODEL: metadata.types.SEMANTIC_MODEL,
+            },
+        };
+        mockAxiosGet(
+            "https://myTeam.celonis.cloud/pacman/api/core/asset-registry/types",
+            withDescription
+        );
+
+        await new AssetRegistryService(testContext).listTypes(false);
+
+        expect(loggingTestTransport.logMessages.length).toBe(1);
+        expect(loggingTestTransport.logMessages[0].message).toContain(
+            "SEMANTIC_MODEL - Knowledge Model [DATA_AND_PROCESS_MODELING] - Defines KPIs, records, filters, and data bindings for analytics"
+        );
+    });
+
+    it("Should omit the description when it is not present", async () => {
+        const withoutDescription: AssetRegistryMetadata = {
+            types: {
+                BOARD_V2: metadata.types.BOARD_V2
+            },
+        };
+        mockAxiosGet(
+            "https://myTeam.celonis.cloud/pacman/api/core/asset-registry/types",
+            withoutDescription
+        );
 
         await new AssetRegistryService(testContext).listTypes(false);
 
-        expect(loggingTestTransport.logMessages.length).toBe(2);
-        expect(loggingTestTransport.logMessages[0].message).toContain("BOARD_V2");
-        expect(loggingTestTransport.logMessages[0].message).toContain("View");
-        expect(loggingTestTransport.logMessages[0].message).toContain("DASHBOARDS");
-        expect(loggingTestTransport.logMessages[1].message).toContain("SEMANTIC_MODEL");
-        expect(loggingTestTransport.logMessages[1].message).toContain("Knowledge Model");
+        expect(loggingTestTransport.logMessages.length).toBe(1);
+        expect(loggingTestTransport.logMessages[0].message).toContain(
+            "BOARD_V2 - View [DASHBOARDS]"
+        );
+        expect(loggingTestTransport.logMessages[0].message).not.toContain(" - null");
+        expect(loggingTestTransport.logMessages[0].message).not.toMatch(/\] - /);
     });
 
     it("Should list all asset types as JSON", async () => {