feat(tech-inights): adds getFactSchemas method to client

Signed-off-by: Fernando.Teixeira <fernando.Teixeira@traderev.com>
2023-01-25 14:09:15 -05:00
parent bcb490f4db
commit 4024b37449
7 changed files with 85 additions and 59 deletions
@@ -134,3 +134,60 @@ export type BulkCheckResponse = Array<{
  entity: string;
  results: CheckResult[];
 }>;
+
+/**
+ * A record type to specify individual fact shapes
+ *
+ * Used as part of a schema to validate, identify and generically construct usage implementations
+ * of individual fact values in the system.
+ *
+ * @public
+ */
+export type FactSchema = {
+  /**
+   * Name of the fact
+   */
+  [name: string]: {
+    /**
+     * Type of the individual fact value
+     *
+     * Numbers are split into integers and floating point values.
+     * `set` indicates a collection of values, `object` indicates JSON serializable value
+     */
+    type:
+      | 'integer'
+      | 'float'
+      | 'string'
+      | 'boolean'
+      | 'datetime'
+      | 'set'
+      | 'object';
+
+    /**
+     * A description of this individual fact value
+     */
+    description: string;
+
+    /**
+     * Optional semver string to indicate when this specific fact definition was added to the schema
+     */
+    since?: string;
+
+    /**
+     * Metadata related to an individual fact.
+     * Can contain links, additional description texts and other actionable data.
+     *
+     * Currently loosely typed, but in the future when patterns emerge, key shapes can be defined
+     *
+     * examples:
+     * ```
+     * \{
+     *   link: 'https://sonarqube.mycompany.com/fix-these-issues',
+     *   suggestion: 'To affect this value, you can do x, y, z',
+     *   minValue: 0
+     * \}
+     * ```
+     */
+    metadata?: Record<string, any>;
+  };
+};