Skip to content

Commit

Permalink
Automated update to repo's documentation from github action
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jul 6, 2022
1 parent bb66bf0 commit 45f994a
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/answers-core.answerscore.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> AnswersCore is deprecated and has been replaced by SearchCore
> AnswersCore is deprecated and has been replaced by [SearchCore](./answers-core.searchcore.md)
>
<b>Signature:</b>
Expand Down
8 changes: 4 additions & 4 deletions docs/answers-core.answerserror.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [AnswersError](./answers-core.answerserror.md)

## AnswersError type
## AnswersError interface

> Warning: This API is now obsolete.
>
> AnswersError is deprecated and has been replaced by SearchError
> AnswersError is deprecated and has been replaced by [SearchError](./answers-core.searcherror.md)
>
<b>Signature:</b>

```typescript
export declare type AnswersError = SearchError;
export interface AnswersError extends SearchError
```
<b>References:</b> [SearchError](./answers-core.searcherror.md)
<b>Extends:</b> [SearchError](./answers-core.searcherror.md)
8 changes: 4 additions & 4 deletions docs/answers-core.answersrequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [AnswersRequest](./answers-core.answersrequest.md)

## AnswersRequest type
## AnswersRequest interface

> Warning: This API is now obsolete.
>
> AnswersRequest is deprecated and has been replaced by SearchRequest
> AnswersRequest is deprecated and has been replaced by [SearchRequest](./answers-core.searchrequest.md)
>
<b>Signature:</b>

```typescript
export declare type AnswersRequest = SearchRequest;
export interface AnswersRequest extends SearchRequest
```
<b>References:</b> [SearchRequest](./answers-core.searchrequest.md)
<b>Extends:</b> [SearchRequest](./answers-core.searchrequest.md)
4 changes: 2 additions & 2 deletions docs/answers-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@
| [AdditionalHttpHeaders](./answers-core.additionalhttpheaders.md) | AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. |
| [AnswersConfigWithApiKey](./answers-core.answersconfigwithapikey.md) | Configuration options for [AnswersCore](./answers-core.answerscore.md)<!-- -->, which includes the options from [BaseAnswersConfig](./answers-core.baseanswersconfig.md)<!-- -->, but requires apiKey. |
| [AnswersConfigWithToken](./answers-core.answersconfigwithtoken.md) | Configuration options for [AnswersCore](./answers-core.answerscore.md)<!-- -->, which includes the options from [BaseAnswersConfig](./answers-core.baseanswersconfig.md)<!-- -->, but requires token. |
| [AnswersError](./answers-core.answerserror.md) | |
| [AnswersRequest](./answers-core.answersrequest.md) | |
| [AppliedQueryFilter](./answers-core.appliedqueryfilter.md) | A filter that the Answers API applied to the search. |
| [AutocompleteResponse](./answers-core.autocompleteresponse.md) | The response of a universal or vertical autocomplete request. |
| [AutocompleteResult](./answers-core.autocompleteresult.md) | An autocomplete suggestion. |
Expand Down Expand Up @@ -103,8 +105,6 @@
| Type Alias | Description |
| --- | --- |
| [AnswersConfig](./answers-core.answersconfig.md) | The main configuration options for [AnswersCore](./answers-core.answerscore.md)<!-- -->. For a full description of the options, see [BaseAnswersConfig](./answers-core.baseanswersconfig.md)<!-- -->. The config requires either an apiKey or a token. |
| [AnswersError](./answers-core.answerserror.md) | |
| [AnswersRequest](./answers-core.answersrequest.md) | |
| [Context](./answers-core.context.md) | Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/)<!-- -->. |
| [HighlightedFields](./answers-core.highlightedfields.md) | A mapping of fields to the values emphasized by the Answers API |

6 changes: 4 additions & 2 deletions etc/answers-core.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,12 @@ export class AnswersCore extends SearchCore {
}

// @public @deprecated (undocumented)
export type AnswersError = SearchError;
export interface AnswersError extends SearchError {
}

// @public @deprecated (undocumented)
export type AnswersRequest = SearchRequest;
export interface AnswersRequest extends SearchRequest {
}

// @public
export interface AppliedQueryFilter {
Expand Down

0 comments on commit 45f994a

Please sign in to comment.