Api report and changelog

Signed-off-by: sblausten <sam@roadie.io>
2022-07-06 13:59:42 +02:00
parent d6ab0613a3
commit bcc122c46d
3 changed files with 21 additions and 0 deletions
@@ -46,12 +46,14 @@ export type FactLifecycle = TTL | MaxItems;

 // @public
 export interface FactRetriever {
+  description: string;
  entityFilter?:
    | Record<string, string | symbol | (string | symbol)[]>[]
    | Record<string, string | symbol | (string | symbol)[]>;
  handler: (ctx: FactRetrieverContext) => Promise<TechInsightFact[]>;
  id: string;
  schema: FactSchema;
+  title: string;
  version: string;
 }

@@ -174,6 +174,16 @@ export interface FactRetriever {
   */
  version: string;

+  /**
+   * A short display title for the fact retriever to be used in the interface
+   */
+  title: string;
+
+  /**
+   * A short display description for the fact retriever to be used in the interface.
+   */
+  description: string;
+
  /**
   * Handler function that needs to be implemented to retrieve fact values for entities.
   *