Merge pull request #29 from lifeomic/better-pagination-docs

fix: improve pagination docs

README.md

@@ -211,9 +211,15 @@ Name: listPaginatedPosts
 Request:
   type: object
   properties:
-    filter: { type: string }
-    nextPageToken: { type: string }
-    pageSize: { type: string }
+    filter:
+      type: string
+      optional: true
+    nextPageToken:
+      type: string
+      optional: true
+    pageSize:
+      type: string
+      optional: true
 Response:
   type: object
   properties:
@@ -222,8 +228,11 @@ Response:
     links:
       type: object
       properties:
-        self: { type: string }
-        next: { type: string }
+        self:
+          type: string
+        next:
+          type: string
+          optional: true
 ```
 
 ```typescript

src/generate-axios-client.test.ts

@@ -111,6 +111,11 @@ class Client {
     });
   }
 
+  /**
+   * Paginates exhaustively through the provided \`request\`, using the specified
+   * \`data\`. A \`pageSize\` can be specified in the \`data\` to customize the
+   * page size for pagination.
+   */
   async paginate(request, data, config) {
     const result = [];
 

src/generate-axios-client.ts

@@ -111,6 +111,11 @@ class ${outputClass} {
     })
     .join('\n\n')}
 
+  /**
+   * Paginates exhaustively through the provided \`request\`, using the specified
+   * \`data\`. A \`pageSize\` can be specified in the \`data\` to customize the
+   * page size for pagination.
+   */
   async paginate(request, data, config) {
     const result = [];