Address warnings within api-docs

Move extra info on doc to be under remarks block

Signed-off-by: Jussi Hallila <jussi@hallila.com>

plugins/tech-insights-backend/src/service/fact/createFactRetriever.ts

@@ -23,6 +23,12 @@ import {
  *
  * A helper function to construct fact retriever registrations.
  *
+ * @param cadence - cron expression to indicate when the fact retriever should be triggered
+ * @param factRetriever - Implementation of fact retriever consisting of at least id, version, schema and handler
+ *
+ *
+ * @remarks
+ *
  * Cron expressions help:
  * ┌────────────── second (optional)
  # │ ┌──────────── minute
@@ -34,9 +40,6 @@ import {
  # │ │ │ │ │ │
  # * * * * * *
  *
- *
- * @param cadence - cron expression to indicate when the fact retriever should be triggered
- * @param factRetriever - Implementation of fact retriever consisting of at least id, version, schema and handler
  */
 export function createFactRetrieverRegistration(
   cadence: string,

plugins/tech-insights-node/api-report.md

@@ -39,10 +39,6 @@ export interface FactCheckerFactory<
 
 // @public
 export interface FactRetriever {
-  // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
-  // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
-  // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
-  // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
   entityFilter?:
     | Record<string, string | symbol | (string | symbol)[]>[]
     | Record<string, string | symbol | (string | symbol)[]>;
@@ -75,9 +71,7 @@ export type FactSchema = {
   };
 };
 
-// Warning: (ae-missing-release-tag) "FactSchemaDefinition" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export type FactSchemaDefinition = Omit<FactRetriever, 'handler'>;
 
 // @public

plugins/tech-insights-node/src/facts.ts

@@ -179,14 +179,20 @@ export interface FactRetriever {
    * If omitted, the retriever should apply to all entities.
    *
    * Should be defined for example:
-   *   { field: 'kind', values: ['component'] }
-   *   { field: 'metadata.name', values: ['component-1', 'component-2'] }
+   *   \{ field: 'kind', values: \['component'\] \}
+   *   \{ field: 'metadata.name', values: \['component-1', 'component-2'\] \}
    */
   entityFilter?:
     | Record<string, string | symbol | (string | symbol)[]>[]
     | Record<string, string | symbol | (string | symbol)[]>;
 }
 
+/**
+ * @public
+ *
+ * A flat serializable structure for Facts.
+ * Containing information about fact schema, version, id, and entity filters
+ */
 export type FactSchemaDefinition = Omit<FactRetriever, 'handler'>;
 
 /**