Merge pull request #184 from tutorcruncher/pagination-section

Added Pagination Section

Author: HenryTraill

pages/api.yml

@@ -20,6 +20,10 @@ info_sections:
     title: Custom Fields
     id: custom-fields
     layout: /custom-fields/custom-fields.yml
+  -
+    title: Pagination
+    id: pagination
+    layout: /pagination/pagination.yml
 #  -
 #    title: Filters
 #    id: filters

pages/pagination/list-pagination.json

@@ -0,0 +1,11 @@
+{
+  "count": 125,
+  "next": "https://secure.tutorcruncher.com/api/contractors/?page=2",
+  "previous": null,
+  "results": [
+    { "id": 1, "first_name": "John", "last_name": "Doe", ... },
+    { "id": 2, "first_name": "Jane", "last_name": "Smith", ... },
+    ...
+  ]
+}
+

pages/pagination/pagination-object.yml

@@ -0,0 +1,15 @@
+attributes:
+  -
+    name: count
+    type: integer
+    description: The total number of objects available.
+  -
+    name: next
+    type: string
+    description: The URL of the next page of objects.
+  -
+    name: previous
+    type: string
+    description: The URL of the previous page of objects.
+
+

pages/pagination/pagination.md

@@ -0,0 +1,2 @@
+All list-based GET requests in the TutorCruncher API are paginated to handle large datasets efficiently.
+Each page contains up to 100 result objects.

pages/pagination/pagination.py

@@ -0,0 +1,15 @@
+import pprint
+import requests
+
+headers = {'Authorization': 'token <API KEY>'}
+url = 'https://secure.tutorcruncher.com/api/contractors/'
+
+response = requests.get(url, headers=headers)
+data = response.json()
+pprint.pprint(data['results'])
+
+while data.get('next_page'):
+    url = data['next_page']
+    response = requests.get(url, headers=headers)
+    data = response.json()
+    pprint.pprint(data['results'])

pages/pagination/pagination.yml

@@ -0,0 +1,9 @@
+sections:
+  -
+    description: /pagination/pagination.md
+    attributes: /pagination/pagination-object.yml
+    code: /pagination/pagination.py
+    code_type: GET
+    response: /pagination/list-pagination.json
+    response_title: RESPONSE
+