Address warnings within api-docs

Move extra info on doc to be under remarks block

Signed-off-by: Jussi Hallila <jussi@hallila.com>
This commit is contained in:
Jussi Hallila
2021-10-29 15:14:51 +02:00
parent 9c19d6ad01
commit b863feefbb
3 changed files with 15 additions and 12 deletions
+8 -2
View File
@@ -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'>;
/**