From e594f97f42c9869dce3c2253876cc23b53f4fdd7 Mon Sep 17 00:00:00 2001 From: CI Date: Tue, 16 Jan 2024 20:43:24 +0000 Subject: [PATCH] Updated OpenAPI specs --- json/answersapi.json | 4 ++-- yaml/answersapi.yaml | 10 ++++++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/json/answersapi.json b/json/answersapi.json index cdd9c7b..200011c 100644 --- a/json/answersapi.json +++ b/json/answersapi.json @@ -96,7 +96,7 @@ } ], "summary": "Universal Search: Query", - "description": "Search for entities across all verticals within a Search experience. Modules are returned for all verticals with relevant entities. Further fine tuning and filtering of the results can then be done using the vertical query endpoint. A maximum of 50 verticals can be queried with this endpoint.", + "description": "Search for entities across all verticals within a Search experience. Modules are returned for all verticals with relevant entities. Further fine tuning and filtering of the results can then be done using the vertical query endpoint. A maximum of 50 verticals can be queried with this endpoint.\n\nIn order prevent bot traffic from using Search API Capacity, you must integrate with the Search API from the front end of your application. The Search API's Bot Detection feature requires the API to be called directly from the end-user's web browser. If you must integrate with the Search API via another mechanism, all traffic will be charged against your search capacity and some features of Search Analytics, such as Search Terms and Search Term Clustering may not work.\n", "responses": { "200": { "$ref": "#/components/responses/UniversalQueryResponse" @@ -214,7 +214,7 @@ } ], "summary": "Vertical Search: Query", - "description": "Search for entities within the selected vertical. Vertical query allows for fine tuning of the search using filters, facets and sorts passed in through the API.", + "description": "Search for entities within the selected vertical. Vertical query allows for fine tuning of the search using filters, facets and sorts passed in through the API.\n\nIn order prevent bot traffic from using Search API Capacity, you must integrate with the Search API from the front end of your application. The Search API's Bot Detection feature requires the API to be called directly from the end-user's web browser. If you must integrate with the Search API via another mechanism, all traffic will be charged against your search capacity and some features of Search Analytics, such as Search Terms and Search Term Clustering may not work.\n", "responses": { "200": { "$ref": "#/components/responses/VerticalQueryResponse" diff --git a/yaml/answersapi.yaml b/yaml/answersapi.yaml index 2b5e674..39f3396 100644 --- a/yaml/answersapi.yaml +++ b/yaml/answersapi.yaml @@ -42,7 +42,10 @@ paths: - $ref: '#/components/parameters/queryId' - $ref: '#/components/parameters/jsLibVersion' summary: 'Universal Search: Query' - description: Search for entities across all verticals within a Search experience. Modules are returned for all verticals with relevant entities. Further fine tuning and filtering of the results can then be done using the vertical query endpoint. A maximum of 50 verticals can be queried with this endpoint. + description: | + Search for entities across all verticals within a Search experience. Modules are returned for all verticals with relevant entities. Further fine tuning and filtering of the results can then be done using the vertical query endpoint. A maximum of 50 verticals can be queried with this endpoint. + + In order prevent bot traffic from using Search API Capacity, you must integrate with the Search API from the front end of your application. The Search API's Bot Detection feature requires the API to be called directly from the end-user's web browser. If you must integrate with the Search API via another mechanism, all traffic will be charged against your search capacity and some features of Search Analytics, such as Search Terms and Search Term Clustering may not work. responses: '200': $ref: '#/components/responses/UniversalQueryResponse' @@ -92,7 +95,10 @@ paths: - $ref: '#/components/parameters/queryId' - $ref: '#/components/parameters/jsLibVersion' summary: 'Vertical Search: Query' - description: Search for entities within the selected vertical. Vertical query allows for fine tuning of the search using filters, facets and sorts passed in through the API. + description: | + Search for entities within the selected vertical. Vertical query allows for fine tuning of the search using filters, facets and sorts passed in through the API. + + In order prevent bot traffic from using Search API Capacity, you must integrate with the Search API from the front end of your application. The Search API's Bot Detection feature requires the API to be called directly from the end-user's web browser. If you must integrate with the Search API via another mechanism, all traffic will be charged against your search capacity and some features of Search Analytics, such as Search Terms and Search Term Clustering may not work. responses: '200': $ref: '#/components/responses/VerticalQueryResponse'