Skip to content

Commit bfe28d9

Browse files
Merge pull request #62 from opengeospatial/Resolving_Issue_12
Resolving Issue #12
2 parents 150e125 + 3d6e5d6 commit bfe28d9

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -216,20 +216,19 @@ An example for content negotiation based on HTTP headers and with query paramete
216216

217217
### Principle #11 - Pagination
218218

219-
OGC Web APIs that may be designed to access large data collections should support pagination. Offset pagination is one of the simplest to implement. Offset pagination is specified using the limit and offset commands. Offset pagination is popular with apps powered by SQL databases, as limit and offset are already included with the SQL SELECT library. Offset pagination requires almost no programming. It’s also stateless on the server side and works regardless of custom sort_by parameters.
219+
OGC Web APIs designed to access **listable** collections should support pagination.
220220

221-
The downside of offset pagination is potential performance difficulties when dealing with large offset values and non deterministic reads if resource creation, modification and deletion is allowed.
221+
For one-dimensional lists for example, offset pagination is one of the simplest to implement. Offset pagination is specified using the limit and offset parameters.
222222

223-
As an example, use **limit** and **offset** as "query-string" parameters.
223+
Offset pagination is popular with apps powered by SQL databases, as limit and offset are already included with the SQL SELECT library. Offset pagination requires almost no programming. It’s also stateless on the server side and works regardless of custom sort_by parameters. The downside of offset pagination is potential performance difficulties when dealing with large offset values and non deterministic reads if resource creation, modification and deletion is allowed.
224224

225-
.../collections/highways/items?limit=50&offset=101 => returns upto 50 highways starting at position 101
225+
As an example, use `limit` and `offset` as `query-string` parameters.
226226

227-
The OGC defined Web API should return metadata with each response providing the total number of resources available (e.g. total) in the payload as well as the link to the next page.
227+
.../collections/highways/items?limit=50&offset=101 => returns upto 50 highways starting at position 101
228228

229-
As a supplement consider support for Web Linking (RFC 5988)
229+
The OGC Web API should return metadata with each response providing the total number of resources available (e.g. total) in the payload.
230230

231-
– Use HTTP Response Header to provide URLs for fetching the next / previous page
232-
– This approach is application neutral and should be provided by the API as the default
231+
As a supplement to using `limit` and `offset`, support Web Linking [RFC 5988](https://tools.ietf.org/html/rfc5988) that provides URLs for fetching the next / previous page, e.g. using HTTP Response Headers.
233232

234233
### Principle #12 – Processing Resources
235234

0 commit comments

Comments
 (0)