Updated OpenAPI specs

yext · Aug 7, 2024 · 1955eb1 · 1955eb1
1 parent 3cd1d83
commit 1955eb1
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 7 deletions.
diff --git a/json/knowledgeapi.json b/json/knowledgeapi.json
@@ -56622,6 +56622,14 @@
         {
           "$ref": "#/components/parameters/clientCategoryId"
         },
+        {
+          "schema": {
+            "type": "string"
+          },
+          "name": "entityId",
+          "in": "query",
+          "description": "The external ID of an entity that, if specified, will filter the result to only include any Google Fields that the provided entity has access to.\n\n**NOTE:** The **`entityId`** parameter will only be respected for **`v`** parameters of `20241030` or later.\n"
+        },
         {
           "$ref": "#/components/parameters/countryCode"
         },
@@ -56635,7 +56643,7 @@
           "Knowledge Manager"
         ],
         "summary": "Google Fields: List",
-        "description": "\nUse the Google Fields endpoint to retrieve a complete list of Google's location attributes for each business category. This list includes attributes that may not apply to all Locations in an account. The set of attributes available to a Location depends on its primary business category. You can view and edit the attributes of Locations in the **`googleAttributes`** Location field.\n\n**NOTE:** Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes.\n",
+        "description": "\nUse the Google Fields endpoint to retrieve a complete list of Google's location attributes for each business category. This list includes attributes that may not apply to all Locations in an account. The set of attributes available to a Location depends on its primary business category and country. You can view and edit the attributes of Locations in the **`googleAttributes`** Location field.\n\n**NOTE:**\n  * Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes.\n  * Only one of **`entityId`** or **`clientCategoryId`** can be specified at a time.\n",
         "responses": {
           "200": {
             "$ref": "#/components/responses/GoogleFieldsResponse"
@@ -87216,7 +87224,7 @@
             "items": {
               "type": "string"
             },
-            "description": "All category IDs taken from either the business' partner category list, if defined, or otherwise from Yext, that map to this Google category."
+            "description": "All category IDs taken from either the business' partner category list, if defined, or otherwise from Yext, that map to this Google category.\n\n**NOTE**: If the **`v`** parameter is `20241030` or later, this field will only be returned if no filter is given (i.e. no **`clientCategoryId`** or **`entityId`**).\n"
           },
           "fields": {
             "type": "array",
@@ -98948,7 +98956,7 @@
         "schema": {
           "type": "string"
         },
-        "description": "A category id for the business that, if specified, will filter the result to only include any Google Fields that the provided id maps to.\n"
+        "description": "A category id for the business or a Google category ID that, if specified, will filter the result to only include any Google Fields that the provided id maps to.\n"
       },
       "countryCode": {
         "name": "countryCode",

diff --git a/yaml/knowledgeapi.yaml b/yaml/knowledgeapi.yaml
@@ -87573,6 +87573,14 @@ paths:
     parameters:
       - $ref: '#/components/parameters/language'
       - $ref: '#/components/parameters/clientCategoryId'
+      - schema:
+          type: string
+        name: entityId
+        in: query
+        description: |
+          The external ID of an entity that, if specified, will filter the result to only include any Google Fields that the provided entity has access to.
+
+          **NOTE:** The **`entityId`** parameter will only be respected for **`v`** parameters of `20241030` or later.
       - $ref: '#/components/parameters/countryCode'
       - $ref: '#/components/parameters/v'
     get:
@@ -87582,9 +87590,11 @@ paths:
       summary: 'Google Fields: List'
       description: |
 
-        Use the Google Fields endpoint to retrieve a complete list of Google's location attributes for each business category. This list includes attributes that may not apply to all Locations in an account. The set of attributes available to a Location depends on its primary business category. You can view and edit the attributes of Locations in the **`googleAttributes`** Location field.
+        Use the Google Fields endpoint to retrieve a complete list of Google's location attributes for each business category. This list includes attributes that may not apply to all Locations in an account. The set of attributes available to a Location depends on its primary business category and country. You can view and edit the attributes of Locations in the **`googleAttributes`** Location field.
 
-        **NOTE:** Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes.
+        **NOTE:**
+          * Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes.
+          * Only one of **`entityId`** or **`clientCategoryId`** can be specified at a time.
       responses:
         '200':
           $ref: '#/components/responses/GoogleFieldsResponse'
@@ -116699,7 +116709,10 @@ components:
           type: array
           items:
             type: string
-          description: All category IDs taken from either the business' partner category list, if defined, or otherwise from Yext, that map to this Google category.
+          description: |
+            All category IDs taken from either the business' partner category list, if defined, or otherwise from Yext, that map to this Google category.
+
+            **NOTE**: If the **`v`** parameter is `20241030` or later, this field will only be returned if no filter is given (i.e. no **`clientCategoryId`** or **`entityId`**).
         fields:
           type: array
           description: List of fields for this category.
@@ -131963,7 +131976,7 @@ components:
       schema:
         type: string
       description: |
-        A category id for the business that, if specified, will filter the result to only include any Google Fields that the provided id maps to.
+        A category id for the business or a Google category ID that, if specified, will filter the result to only include any Google Fields that the provided id maps to.
     countryCode:
       name: countryCode
       in: query