From 1846ff33ca7fa7b8f329ae3acd03a7d6ea3679f2 Mon Sep 17 00:00:00 2001 From: Tim Black Date: Wed, 7 Nov 2018 17:31:41 -0800 Subject: [PATCH] Revision to for null value on last page Following discussion #165, suggestion adds a explicit requirement for the last page of any paginated payload to return a value of `null` for the `next` key. --- provider/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/provider/README.md b/provider/README.md index 35d5765e..73a0a852 100644 --- a/provider/README.md +++ b/provider/README.md @@ -39,7 +39,7 @@ MDS defines [JSON Schema](https://json-schema.org/) files for [`trips`][trips-sc ### Pagination -`provider` APIs may decide to paginate the data payload. If so, pagination must comply with the [JSON API](http://jsonapi.org/format/#fetching-pagination) specification. +`provider` APIs may decide to paginate the data payload. If so, pagination must comply with the [JSON API](http://jsonapi.org/format/#fetching-pagination) specification. The following keys must be used for pagination links: @@ -48,7 +48,7 @@ The following keys must be used for pagination links: * `prev`: url to the previous page of data * `next`: url to the next page of data -At a minimum, paginated payloads must include a `next` key. +At a minimum, paginated payloads must include a `next` key, which must be set to `null` to indicate the last page of data. ```json {