Skip to content

Commit 4140ec4

Browse files
fix(specs): compostion run payload example for external injected items (generated)
algolia/api-clients-automation#6291 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Gavin Wade <gavin.wade12@gmail.com>
1 parent 4ff0767 commit 4140ec4

3 files changed

Lines changed: 5 additions & 2 deletions

File tree

packages/composition/model/externalInjectedItem.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
import type { ExternalInjection } from './externalInjection';
44

5+
/**
6+
* Contains a list of objects to inject from an external source.
7+
*/
58
export type ExternalInjectedItem = {
69
items: Array<ExternalInjection>;
710
};

packages/composition/model/externalInjection.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
export type ExternalInjection = {
44
/**
5-
* An objectID injected into an external source.
5+
* An objectID injected from an external source and also present in the targeted index.
66
*/
77
objectID: string;
88

packages/composition/model/params.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ export type Params = {
8282
hitsPerPage?: number | undefined;
8383

8484
/**
85-
* A list of extenrally injected objectID groups into from an external source.
85+
* An object containing keys corresponding to the `key`s from an injection\'s `injectedItems` and values containing a list of hits to inject.
8686
*/
8787
injectedItems?: { [key: string]: ExternalInjectedItem } | undefined;
8888

0 commit comments

Comments
 (0)