Skip to content

Commit efea59e

Browse files
committed
More succinct keys section
1 parent 9e86d1d commit efea59e

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,14 +64,12 @@ and will look something like this:
6464

6565
ApiPagination has three keys for configuration: `key`, `aliases`, and `visible`.
6666

67-
The `key` configuration key allows you to change the name of the pagination key.
68-
For instance, if you wanted to change "pagination" to "paging".
67+
* `key` allows you to change the name of the pagination key.
6968

70-
The `aliases` configuration key allows you to change names of the pagination
71-
keys. For instance, if you wanted to change "page" to "currentPage".
69+
* `aliases` allows you to change names of the pagination detail keys.
7270

73-
The `visible` configuration key allows you to set which pagination keys will be
74-
visible in your rendered response.
71+
* `visible` allows you to set which pagination keys will be exposed in the
72+
response.
7573

7674
An example using all these configuration keys:
7775

0 commit comments

Comments
 (0)