Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
fd4a729
testing
gyDBD May 7, 2021
553dd81
testing
gyDBD May 7, 2021
3b85fe3
second -> secondar, and remove console.log
gyDBD May 7, 2021
c283cca
add secondaryBatchKey
gyDBD May 7, 2021
f967006
add back all tests
gyDBD May 10, 2021
23a427a
rename some functions and add comments for new functions
gyDBD May 11, 2021
b286a39
edit documentation for new functions
gyDBD May 11, 2021
2d4a6bd
data masking
gyDBD May 12, 2021
6116e05
remove console.log in /examples/swapi
gyDBD May 12, 2021
88f8b6d
add error handling
gyDBD May 19, 2021
0a393f7
add cases that secondaryBatchKey is returned in a nested object
gyDBD May 19, 2021
3fb6e34
change to propertyBatchKey and propertyNewKey
gyDBD May 20, 2021
f75e68f
Merge branch 'master' of https://github.com/Yelp/dataloader-codegen i…
gyDBD May 20, 2021
a5e440f
add propertyBatchKey and propertyNewKey to schema.json
gyDBD May 20, 2021
5d2b19d
add more tests to prove this work with other existing config
gyDBD May 20, 2021
8366711
fix some review feedback and add more tests
gyDBD May 21, 2021
15f5670
add more comments
gyDBD Jun 1, 2021
a1a70dd
preserve typescript typing.
gyDBD Jun 2, 2021
acf6fff
add star war end-to-end test
gyDBD Jun 2, 2021
bf485de
add e2e tests for all three cases
gyDBD Jun 4, 2021
16d3180
add comments and change return value to Promise
gyDBD Jun 4, 2021
812c846
update API_DOCS.md
gyDBD Jun 4, 2021
92765fb
add enum mergePropertyOptions to control what style of endpoint it is
gyDBD Jun 11, 2021
7b08aa2
update swapi examples
gyDBD Jun 11, 2021
1aae929
merge with master
gyDBD Jun 30, 2021
c25816b
merge with master
gyDBD Jun 30, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions API_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,8 @@ resources:
commaSeparatedBatchKey: ?string (can only use if isBatchResource=true)
isResponseDictionary: ?boolean (can only use if isBatchResource=true)
isBatchKeyASet: ?boolean (can only use if isBatchResource=true)
propertyBatchKey: ?string (can only use if isBatchResource=true)
propertyNewKey: ?string (can only use if isBatchResource=true)

typings:
language: flow
Expand Down Expand Up @@ -125,6 +127,8 @@ Describes the shape and behaviour of the resources object you will pass to `getL
| `commaSeparatedBatchKey` | (Optional) Set to true if the interface of the resource takes the batch key as a comma separated list (rather than an array of IDs, as is more common). Default: false |
| `isResponseDictionary` | (Optional) Set to true if the batch resource returns the results as a dictionary with key mapped to values (instead of a list of items). If this option is supplied `reorderResultsByKey` should not be. Default: false |
| `isBatchKeyASet` | (Optional) Set to true if the interface of the resource takes the batch key as a set (rather than an array). For example, when using a generated clientlib based on swagger where `uniqueItems: true` is set for the batchKey parameter. Default: false. |
| `propertyBatchKey` | (Optional) (Optional) The argument to the resource that represents the nested list of optional properties we want to fetch. (e.g. usually 'properties' or 'features'). |
| `propertyNewKey` | (Optional) (Optional) The argument we'll replace the propertyBatchKey with - should be a singular version of the propertyBatchKey (e.g. usually 'property' or 'feature'). |

### `typings`

Expand Down
Loading