From b0a7a770fd7a77c21e0b61633fcb96d1cd0aa95b Mon Sep 17 00:00:00 2001 From: tpluscode Date: Sun, 13 May 2018 14:49:19 +0200 Subject: [PATCH 1/3] update the example of partial collections --- drafts/use-cases/3.2.pagination.md | 55 ++++++++++++++++-------------- 1 file changed, 30 insertions(+), 25 deletions(-) diff --git a/drafts/use-cases/3.2.pagination.md b/drafts/use-cases/3.2.pagination.md index 6164e17..cf137d1 100644 --- a/drafts/use-cases/3.2.pagination.md +++ b/drafts/use-cases/3.2.pagination.md @@ -23,7 +23,7 @@ for (const member of data.members) { // do something with the _member_, i.e. display it } // load some more on demand -data = client.get(data.next); +data = client.get(data.view.next); for (const member of data.members) { // do something with more _member_, i.e. display it } @@ -49,24 +49,27 @@ HTTP 200 OK { "@context": "/api/context.jsonld", "@id": "/api/events", - "@type": "PartialCollection", + "@type": "Collection", "manages": { "property": "rdf:type", "object": "schema:Event" }, - "next": "/api/events?page=2", - "first": "/api/events", - "last": "/api/events?page=2", "totalItems": 1, "member": [ - { - "@id": "/api/events/1", - "eventName": "Event 1", - "eventDescription": "Some event 1", - "startDate": "2017-04-19", - "endDate": "2017-04-19" + { + "@id": "/api/events/1", + "eventName": "Event 1", + "eventDescription": "Some event 1", + "startDate": "2017-04-19", + "endDate": "2017-04-19" } - ] + ], + "view": [{ + "@type": "PartialCollectionView", + "next": "/api/events?page=2", + "first": "/api/events", + "last": "/api/events?page=2" + }] } ``` @@ -82,24 +85,26 @@ HTTP 200 OK { "@context": "/api/context.jsonld", "@id": "/api/events?page=2", - "@type": "PartialCollection", + "@type": "Collection", "manages": { "property": "rdf:type", "object": "schema:Event" }, - "previous": "/api/events", - "first": "/api/events", - "last": "/api/events?page=2", "totalItems": 1, "member": [ - { - "@id": "/api/events/1", - "eventName": "Event 1", - "eventDescription": "Some event 1", - "startDate": "2017-04-19", - "endDate": "2017-04-19" - } - ] + { + "@id": "/api/events/1", + "eventName": "Event 1", + "eventDescription": "Some event 1", + "startDate": "2017-04-19", + "endDate": "2017-04-19" + } + ], + "view": [{ + "first": "/api/events", + "previous": "/api/events", + "last": "/api/events?page=2" + }] } ``` @@ -110,4 +115,4 @@ It may be useful to introduce a way to instruct the Hydra client to do so, i.e.: ```javascript let data = client.get("/api/events", { followPartialLinks: true }); -``` \ No newline at end of file +``` From fc4e3a5c188d9520386914b50a5c6a273656ff59 Mon Sep 17 00:00:00 2001 From: tpluscode Date: Sun, 13 May 2018 14:50:09 +0200 Subject: [PATCH 2/3] rename var --- drafts/use-cases/3.2.pagination.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/drafts/use-cases/3.2.pagination.md b/drafts/use-cases/3.2.pagination.md index cf137d1..6f1aade 100644 --- a/drafts/use-cases/3.2.pagination.md +++ b/drafts/use-cases/3.2.pagination.md @@ -18,13 +18,13 @@ So I can start reviewing them with option of loading more on demand. ```javascript const client = new HydraClient(); -let data = client.get("/api/events"); -for (const member of data.members) { +let collection = client.get("/api/events"); +for (const member of collection.members) { // do something with the _member_, i.e. display it } // load some more on demand -data = client.get(data.view.next); -for (const member of data.members) { +collection = client.get(data.view.next); +for (const member of collection.members) { // do something with more _member_, i.e. display it } ``` From 13c3c6fb962eea86fe7bf3b502ed4281a30d7c3b Mon Sep 17 00:00:00 2001 From: tpluscode Date: Sun, 13 May 2018 14:52:33 +0200 Subject: [PATCH 3/3] fix snippet where it retrieves the view --- drafts/use-cases/3.2.pagination.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/drafts/use-cases/3.2.pagination.md b/drafts/use-cases/3.2.pagination.md index 6f1aade..427f9ba 100644 --- a/drafts/use-cases/3.2.pagination.md +++ b/drafts/use-cases/3.2.pagination.md @@ -23,7 +23,7 @@ for (const member of collection.members) { // do something with the _member_, i.e. display it } // load some more on demand -collection = client.get(data.view.next); +collection = client.get(data.view[0].next); for (const member of collection.members) { // do something with more _member_, i.e. display it }