aws / aws/aws-appsync-community

DynamoDBBatchGetItemRequest has incorrect type

Open
#360 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
507
Forks
37
PR merge metrics
No merged PRs in 30d

Description

The type for `DynamoDBBatchGetItemRequest` includes projection as a top level attribute:
```
export type DynamoDBBatchGetItemRequest = {
operation: 'BatchGetItem';
tables: {
[tableName: string]: {
keys: Key[];
consistentRead?: boolean;
};
};
projection?: DynamoDBProjectionExpression;
};
```

But [the documentation](https://docs.aws.amazon.com/appsync/latest/devguide/js-resolver-reference-dynamodb.html#js-aws-appsync-resolver-reference-dynamodb-batch-get-item) shows it should be on the table:

```
type DynamoDBBatchGetItemRequest = {
operation: 'BatchGetItem';
tables: {
[tableName: string]: {
keys: { [key: string]: any }[];
consistentRead?: boolean;
projection?: {
expression: string;
expressionNames?: { [key: string]: string };
};
};
};
};
```

Using version 1.7.0 (the latest as-of posting).

Contributor guide

Open the contributing guide

Research direction

Locate the definition of DynamoDBBatchGetItemRequest and compare its tables structure with the linked AWS AppSync documentation. Confirm that projection is represented within each table entry and update or add the relevant type coverage; done means the type matches the documented BatchGetItem request shape.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.