From cb048885f016fb831d96b91f392ee57ab194fac4 Mon Sep 17 00:00:00 2001 From: Oliver Shi Date: Tue, 16 Aug 2022 11:19:35 -0400 Subject: [PATCH] rename [Type]FeaturedSnippetDirectAnswer -> [Type]SnippetDirectAnswer (#212) This shortens the name and removes a little redundancy. J=NONE TEST=none --- ...search-core.featuredsnippetdirectanswer.md | 4 ++-- docs/search-core.md | 4 ++-- ...ultilinetextfeaturedsnippetdirectanswer.md | 22 ------------------- ...netextfeaturedsnippetdirectanswer.value.md | 13 ----------- ...ilinetextsnippetdirectanswer.fieldtype.md} | 4 ++-- ...h-core.multilinetextsnippetdirectanswer.md | 22 +++++++++++++++++++ ....multilinetextsnippetdirectanswer.value.md | 13 +++++++++++ ....richtextsnippetdirectanswer.fieldtype.md} | 4 ++-- ...earch-core.richtextsnippetdirectanswer.md} | 8 +++---- etc/search-core.api.md | 6 ++--- .../FeaturedSnippetDirectAnswer.ts | 6 ++--- ...ts => MultiLineTextSnippetDirectAnswer.ts} | 2 +- ...swer.ts => RichTextSnippetDirectAnswer.ts} | 2 +- .../featuredsnippetdirectanswers/index.ts | 4 ++-- 14 files changed, 57 insertions(+), 57 deletions(-) delete mode 100644 docs/search-core.multilinetextfeaturedsnippetdirectanswer.md delete mode 100644 docs/search-core.multilinetextfeaturedsnippetdirectanswer.value.md rename docs/{search-core.multilinetextfeaturedsnippetdirectanswer.fieldtype.md => search-core.multilinetextsnippetdirectanswer.fieldtype.md} (51%) create mode 100644 docs/search-core.multilinetextsnippetdirectanswer.md create mode 100644 docs/search-core.multilinetextsnippetdirectanswer.value.md rename docs/{search-core.richtextfeaturedsnippetdirectanswer.fieldtype.md => search-core.richtextsnippetdirectanswer.fieldtype.md} (52%) rename docs/{search-core.richtextfeaturedsnippetdirectanswer.md => search-core.richtextsnippetdirectanswer.md} (52%) rename src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/{MultiLineTextFeaturedSnippetDirectAnswer.ts => MultiLineTextSnippetDirectAnswer.ts} (81%) rename src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/{RichTextFeaturedSnippetDirectAnswer.ts => RichTextSnippetDirectAnswer.ts} (80%) diff --git a/docs/search-core.featuredsnippetdirectanswer.md b/docs/search-core.featuredsnippetdirectanswer.md index e09c2ad9..fb2a6e1f 100644 --- a/docs/search-core.featuredsnippetdirectanswer.md +++ b/docs/search-core.featuredsnippetdirectanswer.md @@ -9,7 +9,7 @@ All possible built-in [BaseFeaturedSnippetDirectAnswer](./search-core.basefeatur Signature: ```typescript -export declare type FeaturedSnippetDirectAnswer = MultiLineTextFeaturedSnippetDirectAnswer | RichTextFeaturedSnippetDirectAnswer; +export declare type FeaturedSnippetDirectAnswer = MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer; ``` -References: [MultiLineTextFeaturedSnippetDirectAnswer](./search-core.multilinetextfeaturedsnippetdirectanswer.md), [RichTextFeaturedSnippetDirectAnswer](./search-core.richtextfeaturedsnippetdirectanswer.md) +References: [MultiLineTextSnippetDirectAnswer](./search-core.multilinetextsnippetdirectanswer.md), [RichTextSnippetDirectAnswer](./search-core.richtextsnippetdirectanswer.md) diff --git a/docs/search-core.md b/docs/search-core.md index 261161a3..fc0c2ec6 100644 --- a/docs/search-core.md +++ b/docs/search-core.md @@ -80,7 +80,7 @@ | [LocationBoundingBox](./search-core.locationboundingbox.md) | Location boundaries for a filter with "Place" for its [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md). (e.g. boundary for a locality or region specific location filter) | | [LocationFilterDetails](./search-core.locationfilterdetails.md) | Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md). | | [LowerNumberRangeLimit](./search-core.lowernumberrangelimit.md) | The start limit of [NumberRangeValue](./search-core.numberrangevalue.md). | -| [MultiLineTextFeaturedSnippetDirectAnswer](./search-core.multilinetextfeaturedsnippetdirectanswer.md) | A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'multi\_line\_text' field type. | +| [MultiLineTextSnippetDirectAnswer](./search-core.multilinetextsnippetdirectanswer.md) | A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'multi\_line\_text' field type. | | [NearFilterValue](./search-core.nearfiltervalue.md) | A filter value for a filter with a $near [Matcher](./search-core.matcher.md). | | [NumberRangeValue](./search-core.numberrangevalue.md) | A filter value for a filter with a $between [Matcher](./search-core.matcher.md). | | [QueryRulesActionsData](./search-core.queryrulesactionsdata.md) | Data returned from the Search query rules system. | @@ -89,7 +89,7 @@ | [QuestionSubmissionService](./search-core.questionsubmissionservice.md) | Submits a custom question to the Search API. | | [Result](./search-core.result.md) | An individual search result. | | [RichTextDirectAnswer](./search-core.richtextdirectanswer.md) | A direct answer for a rich text field. | -| [RichTextFeaturedSnippetDirectAnswer](./search-core.richtextfeaturedsnippetdirectanswer.md) | A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'rich\_text' field type. "value" field is omitted for featured snippet direct answer of this field type. | +| [RichTextSnippetDirectAnswer](./search-core.richtextsnippetdirectanswer.md) | A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'rich\_text' field type. "value" field is omitted for featured snippet direct answer of this field type. | | [SearchConfigWithApiKey](./search-core.searchconfigwithapikey.md) | Configuration options for [SearchCore](./search-core.searchcore.md), which includes the options from [BaseSearchConfig](./search-core.basesearchconfig.md), but requires apiKey. | | [SearchConfigWithToken](./search-core.searchconfigwithtoken.md) | Configuration options for [SearchCore](./search-core.searchcore.md), which includes the options from [BaseSearchConfig](./search-core.basesearchconfig.md), but requires token. | | [SearchParameterField](./search-core.searchparameterfield.md) | Indicates which entity field to perform the autocomplete request on. | diff --git a/docs/search-core.multilinetextfeaturedsnippetdirectanswer.md b/docs/search-core.multilinetextfeaturedsnippetdirectanswer.md deleted file mode 100644 index 9311570a..00000000 --- a/docs/search-core.multilinetextfeaturedsnippetdirectanswer.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/search-core](./search-core.md) > [MultiLineTextFeaturedSnippetDirectAnswer](./search-core.multilinetextfeaturedsnippetdirectanswer.md) - -## MultiLineTextFeaturedSnippetDirectAnswer interface - -A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'multi\_line\_text' field type. - -Signature: - -```typescript -export interface MultiLineTextFeaturedSnippetDirectAnswer extends BaseFeaturedSnippetDirectAnswer -``` -Extends: [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md)<string> - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fieldType](./search-core.multilinetextfeaturedsnippetdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.MultiLineText](./search-core.builtinfieldtype.md)> | The field type of the direct answer. | -| [value](./search-core.multilinetextfeaturedsnippetdirectanswer.value.md) | string | The value of the direct answer. | - diff --git a/docs/search-core.multilinetextfeaturedsnippetdirectanswer.value.md b/docs/search-core.multilinetextfeaturedsnippetdirectanswer.value.md deleted file mode 100644 index d42be387..00000000 --- a/docs/search-core.multilinetextfeaturedsnippetdirectanswer.value.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/search-core](./search-core.md) > [MultiLineTextFeaturedSnippetDirectAnswer](./search-core.multilinetextfeaturedsnippetdirectanswer.md) > [value](./search-core.multilinetextfeaturedsnippetdirectanswer.value.md) - -## MultiLineTextFeaturedSnippetDirectAnswer.value property - -The value of the direct answer. - -Signature: - -```typescript -value: string; -``` diff --git a/docs/search-core.multilinetextfeaturedsnippetdirectanswer.fieldtype.md b/docs/search-core.multilinetextsnippetdirectanswer.fieldtype.md similarity index 51% rename from docs/search-core.multilinetextfeaturedsnippetdirectanswer.fieldtype.md rename to docs/search-core.multilinetextsnippetdirectanswer.fieldtype.md index 4ccad829..cd86822f 100644 --- a/docs/search-core.multilinetextfeaturedsnippetdirectanswer.fieldtype.md +++ b/docs/search-core.multilinetextsnippetdirectanswer.fieldtype.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/search-core](./search-core.md) > [MultiLineTextFeaturedSnippetDirectAnswer](./search-core.multilinetextfeaturedsnippetdirectanswer.md) > [fieldType](./search-core.multilinetextfeaturedsnippetdirectanswer.fieldtype.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [MultiLineTextSnippetDirectAnswer](./search-core.multilinetextsnippetdirectanswer.md) > [fieldType](./search-core.multilinetextsnippetdirectanswer.fieldtype.md) -## MultiLineTextFeaturedSnippetDirectAnswer.fieldType property +## MultiLineTextSnippetDirectAnswer.fieldType property The field type of the direct answer. diff --git a/docs/search-core.multilinetextsnippetdirectanswer.md b/docs/search-core.multilinetextsnippetdirectanswer.md new file mode 100644 index 00000000..dbe3bc75 --- /dev/null +++ b/docs/search-core.multilinetextsnippetdirectanswer.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [MultiLineTextSnippetDirectAnswer](./search-core.multilinetextsnippetdirectanswer.md) + +## MultiLineTextSnippetDirectAnswer interface + +A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'multi\_line\_text' field type. + +Signature: + +```typescript +export interface MultiLineTextSnippetDirectAnswer extends BaseFeaturedSnippetDirectAnswer +``` +Extends: [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md)<string> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldType](./search-core.multilinetextsnippetdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.MultiLineText](./search-core.builtinfieldtype.md)> | The field type of the direct answer. | +| [value](./search-core.multilinetextsnippetdirectanswer.value.md) | string | The value of the direct answer. | + diff --git a/docs/search-core.multilinetextsnippetdirectanswer.value.md b/docs/search-core.multilinetextsnippetdirectanswer.value.md new file mode 100644 index 00000000..8184b639 --- /dev/null +++ b/docs/search-core.multilinetextsnippetdirectanswer.value.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [MultiLineTextSnippetDirectAnswer](./search-core.multilinetextsnippetdirectanswer.md) > [value](./search-core.multilinetextsnippetdirectanswer.value.md) + +## MultiLineTextSnippetDirectAnswer.value property + +The value of the direct answer. + +Signature: + +```typescript +value: string; +``` diff --git a/docs/search-core.richtextfeaturedsnippetdirectanswer.fieldtype.md b/docs/search-core.richtextsnippetdirectanswer.fieldtype.md similarity index 52% rename from docs/search-core.richtextfeaturedsnippetdirectanswer.fieldtype.md rename to docs/search-core.richtextsnippetdirectanswer.fieldtype.md index 8dcbeb3d..42d81d8d 100644 --- a/docs/search-core.richtextfeaturedsnippetdirectanswer.fieldtype.md +++ b/docs/search-core.richtextsnippetdirectanswer.fieldtype.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/search-core](./search-core.md) > [RichTextFeaturedSnippetDirectAnswer](./search-core.richtextfeaturedsnippetdirectanswer.md) > [fieldType](./search-core.richtextfeaturedsnippetdirectanswer.fieldtype.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [RichTextSnippetDirectAnswer](./search-core.richtextsnippetdirectanswer.md) > [fieldType](./search-core.richtextsnippetdirectanswer.fieldtype.md) -## RichTextFeaturedSnippetDirectAnswer.fieldType property +## RichTextSnippetDirectAnswer.fieldType property The field type of the direct answer. diff --git a/docs/search-core.richtextfeaturedsnippetdirectanswer.md b/docs/search-core.richtextsnippetdirectanswer.md similarity index 52% rename from docs/search-core.richtextfeaturedsnippetdirectanswer.md rename to docs/search-core.richtextsnippetdirectanswer.md index 0699a0fa..231fb466 100644 --- a/docs/search-core.richtextfeaturedsnippetdirectanswer.md +++ b/docs/search-core.richtextsnippetdirectanswer.md @@ -1,15 +1,15 @@ -[Home](./index.md) > [@yext/search-core](./search-core.md) > [RichTextFeaturedSnippetDirectAnswer](./search-core.richtextfeaturedsnippetdirectanswer.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [RichTextSnippetDirectAnswer](./search-core.richtextsnippetdirectanswer.md) -## RichTextFeaturedSnippetDirectAnswer interface +## RichTextSnippetDirectAnswer interface A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'rich\_text' field type. "value" field is omitted for featured snippet direct answer of this field type. Signature: ```typescript -export interface RichTextFeaturedSnippetDirectAnswer extends Omit, 'value'> +export interface RichTextSnippetDirectAnswer extends Omit, 'value'> ``` Extends: Omit<[BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md)<string>, 'value'> @@ -17,5 +17,5 @@ export interface RichTextFeaturedSnippetDirectAnswer extends Omit<[BuiltInFieldType.RichText](./search-core.builtinfieldtype.md)> | The field type of the direct answer. | +| [fieldType](./search-core.richtextsnippetdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.RichText](./search-core.builtinfieldtype.md)> | The field type of the direct answer. | diff --git a/etc/search-core.api.md b/etc/search-core.api.md index aacdaa18..e940fe6e 100644 --- a/etc/search-core.api.md +++ b/etc/search-core.api.md @@ -264,7 +264,7 @@ export interface FailedVertical { } // @public -export type FeaturedSnippetDirectAnswer = MultiLineTextFeaturedSnippetDirectAnswer | RichTextFeaturedSnippetDirectAnswer; +export type FeaturedSnippetDirectAnswer = MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer; // @public export type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | IntegerDirectAnswer; @@ -397,7 +397,7 @@ export enum Matcher { } // @public -export interface MultiLineTextFeaturedSnippetDirectAnswer extends BaseFeaturedSnippetDirectAnswer { +export interface MultiLineTextSnippetDirectAnswer extends BaseFeaturedSnippetDirectAnswer { fieldType: EnumOrLiteral; value: string; } @@ -484,7 +484,7 @@ export interface RichTextDirectAnswer extends BaseFieldValueDirectAnswer, 'value'> { +export interface RichTextSnippetDirectAnswer extends Omit, 'value'> { fieldType: EnumOrLiteral; } diff --git a/src/models/searchservice/response/directanswer/FeaturedSnippetDirectAnswer.ts b/src/models/searchservice/response/directanswer/FeaturedSnippetDirectAnswer.ts index 2322f469..ec48022f 100644 --- a/src/models/searchservice/response/directanswer/FeaturedSnippetDirectAnswer.ts +++ b/src/models/searchservice/response/directanswer/FeaturedSnippetDirectAnswer.ts @@ -4,8 +4,8 @@ import { Snippet } from '../Snippet'; import { BuiltInFieldType } from './BuiltInFieldType'; import { EnumOrLiteral } from '../../../utils/EnumOrLiteral'; import { - MultiLineTextFeaturedSnippetDirectAnswer, - RichTextFeaturedSnippetDirectAnswer + MultiLineTextSnippetDirectAnswer, + RichTextSnippetDirectAnswer } from './featuredsnippetdirectanswers'; /** @@ -28,4 +28,4 @@ export interface BaseFeaturedSnippetDirectAnswer extends DirectAnsw * @public */ export type FeaturedSnippetDirectAnswer = - MultiLineTextFeaturedSnippetDirectAnswer | RichTextFeaturedSnippetDirectAnswer; + MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer; diff --git a/src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/MultiLineTextFeaturedSnippetDirectAnswer.ts b/src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/MultiLineTextSnippetDirectAnswer.ts similarity index 81% rename from src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/MultiLineTextFeaturedSnippetDirectAnswer.ts rename to src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/MultiLineTextSnippetDirectAnswer.ts index ff8ffc02..c3c4a2e4 100644 --- a/src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/MultiLineTextFeaturedSnippetDirectAnswer.ts +++ b/src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/MultiLineTextSnippetDirectAnswer.ts @@ -7,7 +7,7 @@ import { BaseFeaturedSnippetDirectAnswer } from '../FeaturedSnippetDirectAnswer' * * @public */ -export interface MultiLineTextFeaturedSnippetDirectAnswer extends BaseFeaturedSnippetDirectAnswer { +export interface MultiLineTextSnippetDirectAnswer extends BaseFeaturedSnippetDirectAnswer { /** The value of the direct answer. */ value: string, /** {@inheritDoc DirectAnswer.fieldType} */ diff --git a/src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/RichTextFeaturedSnippetDirectAnswer.ts b/src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/RichTextSnippetDirectAnswer.ts similarity index 80% rename from src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/RichTextFeaturedSnippetDirectAnswer.ts rename to src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/RichTextSnippetDirectAnswer.ts index b7cf61fc..fe60225a 100644 --- a/src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/RichTextFeaturedSnippetDirectAnswer.ts +++ b/src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/RichTextSnippetDirectAnswer.ts @@ -8,7 +8,7 @@ import { BaseFeaturedSnippetDirectAnswer } from '../FeaturedSnippetDirectAnswer' * * @public */ -export interface RichTextFeaturedSnippetDirectAnswer extends Omit, 'value'> { +export interface RichTextSnippetDirectAnswer extends Omit, 'value'> { /** {@inheritDoc DirectAnswer.fieldType} */ fieldType: EnumOrLiteral } diff --git a/src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/index.ts b/src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/index.ts index c9601444..61b085e5 100644 --- a/src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/index.ts +++ b/src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/index.ts @@ -1,2 +1,2 @@ -export { RichTextFeaturedSnippetDirectAnswer } from './RichTextFeaturedSnippetDirectAnswer'; -export { MultiLineTextFeaturedSnippetDirectAnswer } from './MultiLineTextFeaturedSnippetDirectAnswer'; +export { RichTextSnippetDirectAnswer } from './RichTextSnippetDirectAnswer'; +export { MultiLineTextSnippetDirectAnswer } from './MultiLineTextSnippetDirectAnswer';