Automated update to repo's documentation from github action

yext · Aug 10, 2022 · 0e5e6e3 · 0e5e6e3
1 parent 031e40f
commit 0e5e6e3
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 14 deletions.
diff --git a/docs/search-core.directanswer.md b/docs/search-core.directanswer.md
@@ -9,7 +9,7 @@ A direct answer to a search.
 <b>Signature:</b>
 
 ```typescript
-export interface DirectAnswer 
+export interface DirectAnswer<T = unknown> 
 ```
 
 ## Properties
@@ -19,6 +19,6 @@ export interface DirectAnswer
 |  [fieldType](./search-core.directanswer.fieldtype.md) | string | The field type of the direct answer. |
 |  [relatedResult](./search-core.directanswer.relatedresult.md) | [Result](./search-core.result.md) | The entity associated with the direct answer. |
 |  [type](./search-core.directanswer.type.md) | [DirectAnswerType](./search-core.directanswertype.md) | The [DirectAnswerType](./search-core.directanswertype.md)<!-- -->. |
-|  [value?](./search-core.directanswer.value.md) | string | <i>(Optional)</i> The result of the direct answer. |
+|  [value?](./search-core.directanswer.value.md) | T | <i>(Optional)</i> The result of the direct answer. |
 |  [verticalKey](./search-core.directanswer.verticalkey.md) | string | The vertical key of the direct answer. |
 
diff --git a/docs/search-core.directanswer.value.md b/docs/search-core.directanswer.value.md
@@ -9,7 +9,7 @@ The result of the direct answer.
 <b>Signature:</b>
 
 ```typescript
-value?: string;
+value?: T;
 ```
 
 ## Remarks

diff --git a/docs/search-core.featuredsnippetdirectanswer.md b/docs/search-core.featuredsnippetdirectanswer.md
@@ -9,9 +9,9 @@ A direct answer which was found within a document.
 <b>Signature:</b>
 
 ```typescript
-export interface FeaturedSnippetDirectAnswer extends DirectAnswer 
+export interface FeaturedSnippetDirectAnswer extends DirectAnswer<string> 
 ```
-<b>Extends:</b> [DirectAnswer](./search-core.directanswer.md)
+<b>Extends:</b> [DirectAnswer](./search-core.directanswer.md)<!-- -->&lt;string&gt;
 
 ## Properties
 

diff --git a/docs/search-core.fieldvaluedirectanswer.md b/docs/search-core.fieldvaluedirectanswer.md
@@ -9,9 +9,9 @@ A direct answer where the answer came from a field from the knowledge graph.
 <b>Signature:</b>
 
 ```typescript
-export interface FieldValueDirectAnswer extends DirectAnswer 
+export interface FieldValueDirectAnswer<T = unknown> extends DirectAnswer<T> 
 ```
-<b>Extends:</b> [DirectAnswer](./search-core.directanswer.md)
+<b>Extends:</b> [DirectAnswer](./search-core.directanswer.md)<!-- -->&lt;T&gt;
 
 ## Properties
 
@@ -23,6 +23,6 @@ export interface FieldValueDirectAnswer extends DirectAnswer
 |  [fieldType](./search-core.fieldvaluedirectanswer.fieldtype.md) | string | The field type of the direct answer. |
 |  [relatedResult](./search-core.fieldvaluedirectanswer.relatedresult.md) | [Result](./search-core.result.md) | The entity associated with the direct answer. |
 |  [type](./search-core.fieldvaluedirectanswer.type.md) | [DirectAnswerType.FieldValue](./search-core.directanswertype.md) | [DirectAnswerType](./search-core.directanswertype.md)<!-- -->.FieldValue. |
-|  [value](./search-core.fieldvaluedirectanswer.value.md) | string | The result of the direct answer. |
+|  [value](./search-core.fieldvaluedirectanswer.value.md) | T | The result of the direct answer. |
 |  [verticalKey](./search-core.fieldvaluedirectanswer.verticalkey.md) | string | The vertical key of the direct answer. |
 
diff --git a/docs/search-core.fieldvaluedirectanswer.value.md b/docs/search-core.fieldvaluedirectanswer.value.md
@@ -9,7 +9,7 @@ The result of the direct answer.
 <b>Signature:</b>
 
 ```typescript
-value: string;
+value: T;
 ```
 
 ## Remarks

diff --git a/etc/search-core.api.md b/etc/search-core.api.md
@@ -109,11 +109,11 @@ export interface CombinedFilter {
 export type Context = any;
 
 // @public
-export interface DirectAnswer {
+export interface DirectAnswer<T = unknown> {
     fieldType: string;
     relatedResult: Result;
     type: DirectAnswerType;
-    value?: string;
+    value?: T;
     verticalKey: string;
 }
 
@@ -195,7 +195,7 @@ export interface FailedVertical {
 }
 
 // @public
-export interface FeaturedSnippetDirectAnswer extends DirectAnswer {
+export interface FeaturedSnippetDirectAnswer extends DirectAnswer<string> {
     fieldType: string;
     relatedResult: Result;
     snippet: Snippet;
@@ -205,14 +205,14 @@ export interface FeaturedSnippetDirectAnswer extends DirectAnswer {
 }
 
 // @public
-export interface FieldValueDirectAnswer extends DirectAnswer {
+export interface FieldValueDirectAnswer<T = unknown> extends DirectAnswer<T> {
     entityName: string;
     fieldApiName: string;
     fieldName: string;
     fieldType: string;
     relatedResult: Result;
     type: DirectAnswerType.FieldValue;
-    value: string;
+    value: T;
     verticalKey: string;
 }