Add section on pagination design to README #128
Conversation
Remove unnecessary items from the `access` slice in one of the unit tests. Each item in `access` corresponds to one request in `apiOps`, so they should have the same number of elements.
Add a section describing the design of pagination-related query parameters (filter, sort, page, etc) to the README, including how testing is implemented.
|
Fixed a typo and added some missing information to the API section |
|
|
||
|  | ||
|
|
||
| #### Unit tests |
There was a problem hiding this comment.
Nit: While I think that the section on integration tests is useful (since those are in a separate repo in a hard-to-identify location), I'm not sure that I feel the same way on the unit tests. As long as you know what packages the code is in, it's easy to identify the test files. I would recommend just identifying the packages that are relevant to the list processor instead of including the section on unit tests.
There was a problem hiding this comment.
It may be obvious where the unit tests are, but I think it's less obvious what to put in those unit tests. In some cases making changes to pkg/stores/partition/listprocessor could have an effect on the output of pkg/stores/partition/store.go, and it's worthwhile to add tests in both places even if the code in store.go didn't change (even if that's stretching the definition of "unit"), so I think it's valuable to keep that recommendation here.
cmurphy
requested review from
a team,
tomleb,
JonCrowther and
maxsokolovsky
No description provided.