feature: add description field to Component

This commit is contained in:
Nikita Nek Dudnik
2020-05-28 13:42:49 +02:00
parent 13dae31935
commit 3fa037ad18
2 changed files with 8 additions and 1 deletions
+7
View File
@@ -69,6 +69,13 @@ export type EntityMeta = {
*/
name: string;
/**
* The short description of the entity.
*
* A a human readable string.
*/
description: string;
/**
* The namespace that the entity belongs to.
*/
+1 -1
View File
@@ -20,6 +20,6 @@ export function envelopeToComponent(envelope: DescriptorEnvelope): Component {
return {
name: envelope.metadata?.name ?? '',
kind: envelope.kind ?? 'unknown',
description: 'placeholder',
description: envelope.metadata?.description ?? 'placeholder',
};
}