Add missing pagination headers docs for collections (#550)

phrase · Feb 28, 2024 · f97122c · f97122c
1 parent 5767549
commit f97122c
Show file tree

Hide file tree

Showing 54 changed files with 325 additions and 0 deletions.
diff --git a/doc/compiled.json b/doc/compiled.json
diff --git a/headers.yaml b/headers.yaml
@@ -22,3 +22,31 @@ X-Rate-Limit-Reset:
   description: The number of seconds left in the current period
   schema:
     type: integer
+Pagination:
+  description: Pagination details for navigating through a collection of resources, provided in JSON format.
+  schema:
+    type: object
+    properties:
+      total_count:
+        description: Total count of items in the collection.
+        type: integer
+        example: 10
+      total_pages_count:
+        description: Total number of pages available for the collection.
+        type: integer
+        example: 2
+      current_page:
+        description: The current page number.
+        type: integer
+        example: 1
+      current_per_page:
+        description: Number of items currently displayed per page.
+        type: integer
+        example: 5
+      previous_page:
+        description: Page number of the previous page, if available.
+        type: integer
+      next_page:
+        description: Page number of the next page, if available.
+        type: integer
+        example: 2
diff --git a/paths/accounts/index.yaml b/paths/accounts/index.yaml
@@ -26,6 +26,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/accounts/locales.yaml b/paths/accounts/locales.yaml
@@ -27,6 +27,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/authorizations/index.yaml b/paths/authorizations/index.yaml
@@ -26,6 +26,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/bitbucket_syncs/index.yaml b/paths/bitbucket_syncs/index.yaml
@@ -30,6 +30,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/blacklisted_keys/index.yaml b/paths/blacklisted_keys/index.yaml
@@ -33,6 +33,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/branches/index.yaml b/paths/branches/index.yaml
@@ -27,6 +27,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/comment_reactions/index.yaml b/paths/comment_reactions/index.yaml
@@ -35,6 +35,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '403':

diff --git a/paths/comment_replies/index.yaml b/paths/comment_replies/index.yaml
@@ -55,6 +55,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '403':

diff --git a/paths/comments/index.yaml b/paths/comments/index.yaml
@@ -62,6 +62,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/custom_metadata_properties/index.yaml b/paths/custom_metadata_properties/index.yaml
@@ -55,6 +55,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/distributions/index.yaml b/paths/distributions/index.yaml
@@ -27,6 +27,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/documents/index.yaml b/paths/documents/index.yaml
@@ -27,6 +27,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/figma_attachments/index.yaml b/paths/figma_attachments/index.yaml
@@ -33,6 +33,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   "400":
     "$ref": "../../responses.yaml#/400"
   "404":

diff --git a/paths/formats/index.yaml b/paths/formats/index.yaml
@@ -24,6 +24,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/gitlab_syncs/history.yaml b/paths/gitlab_syncs/history.yaml
@@ -33,6 +33,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/gitlab_syncs/import.yaml b/paths/gitlab_syncs/import.yaml
@@ -25,6 +25,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/gitlab_syncs/index.yaml b/paths/gitlab_syncs/index.yaml
@@ -30,6 +30,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/glossaries/index.yaml b/paths/glossaries/index.yaml
@@ -27,6 +27,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/glossary_terms/index.yaml b/paths/glossary_terms/index.yaml
@@ -28,6 +28,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/invitations/index.yaml b/paths/invitations/index.yaml
@@ -27,6 +27,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '401':

diff --git a/paths/job_comments/index.yaml b/paths/job_comments/index.yaml
@@ -38,6 +38,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/job_locales/index.yaml b/paths/job_locales/index.yaml
@@ -34,6 +34,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/job_template_locales/index.yaml b/paths/job_template_locales/index.yaml
@@ -34,6 +34,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/job_templates/index.yaml b/paths/job_templates/index.yaml
@@ -33,6 +33,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   "400":
     "$ref": "../../responses.yaml#/400"
   "404":

diff --git a/paths/jobs/index.yaml b/paths/jobs/index.yaml
@@ -51,6 +51,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/jobs/index_account.yaml b/paths/jobs/index_account.yaml
@@ -45,6 +45,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/keys/index.yaml b/paths/keys/index.yaml
@@ -70,6 +70,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/locales/index.yaml b/paths/locales/index.yaml
@@ -39,6 +39,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/members/index.yaml b/paths/members/index.yaml
@@ -27,6 +27,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '401':

diff --git a/paths/notification_groups/index.yaml b/paths/notification_groups/index.yaml
@@ -26,6 +26,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/notifications/index.yaml b/paths/notifications/index.yaml
@@ -32,6 +32,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/orders/index.yaml b/paths/orders/index.yaml
@@ -33,6 +33,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/organization_job_template_locales/index.yaml b/paths/organization_job_template_locales/index.yaml
@@ -28,6 +28,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/organization_job_templates/index.yaml b/paths/organization_job_templates/index.yaml
@@ -27,6 +27,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   "400":
     "$ref": "../../responses.yaml#/400"
   "404":

diff --git a/paths/projects/index.yaml b/paths/projects/index.yaml
@@ -41,6 +41,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/releases/index.yaml b/paths/releases/index.yaml
@@ -28,6 +28,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/screenshot_markers/index.yaml b/paths/screenshot_markers/index.yaml
@@ -34,6 +34,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/screenshots/index.yaml b/paths/screenshots/index.yaml
@@ -39,6 +39,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/spaces/index.yaml b/paths/spaces/index.yaml
@@ -27,6 +27,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':

diff --git a/paths/spaces/spaces_projects.yaml b/paths/spaces/spaces_projects.yaml
@@ -28,6 +28,8 @@ responses:
         "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
       Link:
         "$ref": "../../headers.yaml#/Link"
+      Pagination:
+        "$ref": "../../headers.yaml#/Pagination"
   '400':
     "$ref": "../../responses.yaml#/400"
   '404':