Skip to content

Commit

Permalink
rename
Browse files Browse the repository at this point in the history
  • Loading branch information
Yen Truong committed Aug 15, 2022
1 parent 6513220 commit 9ee23dd
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 19 deletions.
4 changes: 2 additions & 2 deletions docs/search-core.fieldvaluedirectanswer.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Possible built-in and custom [BaseFieldValueDirectAnswer](./search-core.basefiel
<b>Signature:</b>

```typescript
export declare type FieldValueDirectAnswer = CustomFieldValueDirectAnswer;
export declare type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer;
```
<b>References:</b> [CustomFieldValueDirectAnswer](./search-core.customfieldvaluedirectanswer.md)
<b>References:</b> [UnknownFieldValueDirectAnswer](./search-core.unknownfieldvaluedirectanswer.md)

2 changes: 1 addition & 1 deletion docs/search-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@
| [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) | A direct answer where the answer came from a field from the knowledge graph. |
| [BaseSearchConfig](./search-core.basesearchconfig.md) | The base configuration options for [SearchCore](./search-core.searchcore.md)<!-- -->. |
| [ClientSDKHeaderValues](./search-core.clientsdkheadervalues.md) | Additional agents and their versions used to create the Search experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent. |
| [CustomFieldValueDirectAnswer](./search-core.customfieldvaluedirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) with a field type outside of [BuiltInFieldType](./search-core.builtinfieldtype.md)<!-- -->. |
| [DirectAnswer](./search-core.directanswer.md) | A direct answer to a search. |
| [DisplayableFacet](./search-core.displayablefacet.md) | A [Facet](./search-core.facet.md) which contains extra fields meant to be displayed to the end user. |
| [DisplayableFacetOption](./search-core.displayablefacetoption.md) | A [FacetOption](./search-core.facetoption.md) with extra data meant to be displayed to the end user. |
Expand Down Expand Up @@ -91,6 +90,7 @@
| [UniversalLimit](./search-core.universallimit.md) | The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. |
| [UniversalSearchRequest](./search-core.universalsearchrequest.md) | Options which can be specified for a universal search. |
| [UniversalSearchResponse](./search-core.universalsearchresponse.md) | A representation of a response from a universal search. |
| [UnknownFieldValueDirectAnswer](./search-core.unknownfieldvaluedirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) with a field type outside of [BuiltInFieldType](./search-core.builtinfieldtype.md)<!-- -->. |
| [UpperNumberRangeLimit](./search-core.uppernumberrangelimit.md) | The end limit of [NumberRangeValue](./search-core.numberrangevalue.md)<!-- -->. |
| [VerticalAutocompleteRequest](./search-core.verticalautocompleterequest.md) | Options for a vertial autocomplete request. |
| [VerticalResults](./search-core.verticalresults.md) | Represents results from a search vertical. |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [CustomFieldValueDirectAnswer](./search-core.customfieldvaluedirectanswer.md) &gt; [fieldType](./search-core.customfieldvaluedirectanswer.fieldtype.md)
[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [UnknownFieldValueDirectAnswer](./search-core.unknownfieldvaluedirectanswer.md) &gt; [fieldType](./search-core.unknownfieldvaluedirectanswer.fieldtype.md)

## CustomFieldValueDirectAnswer.fieldType property
## UnknownFieldValueDirectAnswer.fieldType property

The field type of the direct answer.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [CustomFieldValueDirectAnswer](./search-core.customfieldvaluedirectanswer.md)
[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [UnknownFieldValueDirectAnswer](./search-core.unknownfieldvaluedirectanswer.md)

## CustomFieldValueDirectAnswer interface
## UnknownFieldValueDirectAnswer interface

A [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) with a field type outside of [BuiltInFieldType](./search-core.builtinfieldtype.md)<!-- -->.

<b>Signature:</b>

```typescript
export interface CustomFieldValueDirectAnswer<T = unknown> extends BaseFieldValueDirectAnswer<T>
export interface UnknownFieldValueDirectAnswer<T = unknown> extends BaseFieldValueDirectAnswer<T>
```
<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md)<!-- -->&lt;T&gt;
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [fieldType](./search-core.customfieldvaluedirectanswer.fieldtype.md) | 'unknown' | The field type of the direct answer. |
| [fieldType](./search-core.unknownfieldvaluedirectanswer.fieldtype.md) | 'unknown' | The field type of the direct answer. |
12 changes: 6 additions & 6 deletions etc/search-core.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,11 +119,6 @@ export interface ClientSDKHeaderValues {
// @public
export type Context = any;

// @public
export interface CustomFieldValueDirectAnswer<T = unknown> extends BaseFieldValueDirectAnswer<T> {
fieldType: 'unknown';
}

// @public
export interface DirectAnswer<T = unknown> {
fieldType: EnumOrLiteral<BuiltInFieldType> | 'unknown';
Expand Down Expand Up @@ -216,7 +211,7 @@ export interface FeaturedSnippetDirectAnswer<T = unknown> extends DirectAnswer<T
}

// @public
export type FieldValueDirectAnswer = CustomFieldValueDirectAnswer;
export type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer;

// @public
export interface FieldValueFilter {
Expand Down Expand Up @@ -559,6 +554,11 @@ export interface UniversalSearchResponse {
verticalResults: VerticalResults[];
}

// @public
export interface UnknownFieldValueDirectAnswer<T = unknown> extends BaseFieldValueDirectAnswer<T> {
fieldType: 'unknown';
}

// @public
export interface UpperNumberRangeLimit {
matcher: Matcher.LessThan | Matcher.LessThanOrEqualTo;
Expand Down
2 changes: 1 addition & 1 deletion src/models/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export { LocationFilterDetails, LocationBoundingBox } from './searchservice/resp
export { DirectAnswer } from './searchservice/response/directanswer/DirectAnswer';
export { BaseFieldValueDirectAnswer } from './searchservice/response/directanswer/BaseFieldValueDirectAnswer';
export { FieldValueDirectAnswer } from './searchservice/response/directanswer/FieldValueDirectAnswer';
export { CustomFieldValueDirectAnswer } from './searchservice/response/directanswer/CustomFieldValueDirectAnswer';
export { UnknownFieldValueDirectAnswer } from './searchservice/response/directanswer/UnknownFieldValueDirectAnswer';
export { FeaturedSnippetDirectAnswer } from './searchservice/response/directanswer/FeaturedSnippetDirectAnswer';
export { DirectAnswerType } from './searchservice/response/directanswer/DirectAnswerType';
export { BuiltInFieldType } from './searchservice/response/directanswer/BuiltInFieldType';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import { CustomFieldValueDirectAnswer } from './CustomFieldValueDirectAnswer';
import { UnknownFieldValueDirectAnswer } from './UnknownFieldValueDirectAnswer';

/**
* Possible built-in and custom {@link BaseFieldValueDirectAnswer} interfaces
*
* @public
*/
//add other builtin field value direct answer interfaces here
export type FieldValueDirectAnswer = CustomFieldValueDirectAnswer;
export type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer;
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { BaseFieldValueDirectAnswer } from './BaseFieldValueDirectAnswer';
*
* @public
*/
export interface CustomFieldValueDirectAnswer<T = unknown> extends BaseFieldValueDirectAnswer<T>{
export interface UnknownFieldValueDirectAnswer<T = unknown> extends BaseFieldValueDirectAnswer<T>{
/** {@inheritDoc DirectAnswer.fieldType} */
fieldType: 'unknown'
}

0 comments on commit 9ee23dd

Please sign in to comment.