Updated OpenAPI specs

yext · Jun 10, 2024 · 54eab32 · 54eab32
1 parent 8652d67
commit 54eab32
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 2 deletions.
diff --git a/json/knowledgeapi.json b/json/knowledgeapi.json
@@ -52645,7 +52645,23 @@
             "description": "Number of results to return"
           },
           {
-            "$ref": "#/components/parameters/offset"
+            "name": "offset",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "default": 0,
+              "maximum": 9900
+            },
+            "description": "\nNumber of results to skip. Used to page through results.\nCannot be used together with **`pageToken`**.\n\nIf the **`v`** parameter is before `20240626`, the maximum offset is not enforced.\nHowever, users are still encouraged to migrate to **`pageToken`** for queries requiring\nlarge offsets, as these may result in errors.\n"
+          },
+          {
+            "name": "pageToken",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "description": "If a response to a previous request contained the **`nextPageToken`** field, pass that\nfield's value as the **`pageToken`** parameter to retrieve the next page of data.\n\nThe **`pageToken`** parameter will only be respected with the inclusion of a **`v`**\nparameter of `20240626` or later.\n"
           },
           {
             "name": "locationIds",

diff --git a/yaml/knowledgeapi.yaml b/yaml/knowledgeapi.yaml
@@ -81996,7 +81996,31 @@ paths:
             default: 10
             maximum: 100
           description: Number of results to return
-        - $ref: '#/components/parameters/offset'
+        - name: offset
+          in: query
+          required: false
+          schema:
+            type: integer
+            default: 0
+            maximum: 9900
+          description: |
+
+            Number of results to skip. Used to page through results.
+            Cannot be used together with **`pageToken`**.
+
+            If the **`v`** parameter is before `20240626`, the maximum offset is not enforced.
+            However, users are still encouraged to migrate to **`pageToken`** for queries requiring
+            large offsets, as these may result in errors.
+        - name: pageToken
+          in: query
+          schema:
+            type: string
+          description: |
+            If a response to a previous request contained the **`nextPageToken`** field, pass that
+            field's value as the **`pageToken`** parameter to retrieve the next page of data.
+
+            The **`pageToken`** parameter will only be respected with the inclusion of a **`v`**
+            parameter of `20240626` or later.
         - name: locationIds
           in: query
           schema: