Skip to content

Commit b2bd06f

Browse files
algolia-botFluf22
algolia-bot
and
Fluf22
committed
chore(website): exclude schema from generated variables file (generated)
algolia/api-clients-automation#5306 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Thomas Raffray <[email protected]>
1 parent b44f754 commit b2bd06f

File tree

3 files changed

+89
-1
lines changed

3 files changed

+89
-1
lines changed

‎src/main/scala/algoliasearch/composition/ExternalInjectedItem.scala‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
/** Composition API The Algolia Composition API lets you run composed search requests on your Compositions. ## Client
2+
* libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. See:
3+
* [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
4+
* Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
5+
* `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
6+
* Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
7+
* URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##
8+
* Retry strategy To guarantee high availability, implement a retry strategy for all API requests using the URLs of
9+
* your servers as fallbacks: - `https://{APPLICATION_ID}-1.algolianet.com` -
10+
* `https://{APPLICATION_ID}-2.algolianet.com` - `https://{APPLICATION_ID}-3.algolianet.com` These URLs use a different
11+
* DNS provider than the primary URLs. You should randomize this list to ensure an even load across the three servers.
12+
* All Algolia API clients implement this retry strategy. ## Authentication To authenticate your API requests, add
13+
* these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the
14+
* necessary permissions to make the request. The required access control list (ACL) to make a request is listed in
15+
* each endpoint's reference. You can find your application ID and API key in the [Algolia
16+
* dashboard](https://dashboard.algolia.com/account). ## Request format Depending on the endpoint, request bodies are
17+
* either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed as query parameters for GET and
18+
* DELETE requests, and in the request body for POST and PUT requests. Query parameters must be
19+
* [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII characters must be
20+
* UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. Arrays as query parameters must be one of: - A
21+
* comma-separated string: `attributesToRetrieve=title,description` - A URL-encoded JSON array:
22+
* `attributesToRetrieve=%5B%22title%22,%22description%22%D` ## Response status and errors The Composition API returns
23+
* JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API
24+
* response. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are
25+
* indicated by a `5xx` status. Error responses have a `message` property with more information. ## Version The current
26+
* version of the Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
27+
*
28+
* The version of the OpenAPI document: 1.0.0
29+
*
30+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
31+
* https://openapi-generator.tech Do not edit the class manually.
32+
*/
33+
package algoliasearch.composition
34+
35+
/** ExternalInjectedItem
36+
*/
37+
case class ExternalInjectedItem(
38+
items: Seq[ExternalInjection]
39+
)

‎src/main/scala/algoliasearch/composition/ExternalInjection.scala‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
/** Composition API The Algolia Composition API lets you run composed search requests on your Compositions. ## Client
2+
* libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. See:
3+
* [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
4+
* Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
5+
* `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
6+
* Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
7+
* URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##
8+
* Retry strategy To guarantee high availability, implement a retry strategy for all API requests using the URLs of
9+
* your servers as fallbacks: - `https://{APPLICATION_ID}-1.algolianet.com` -
10+
* `https://{APPLICATION_ID}-2.algolianet.com` - `https://{APPLICATION_ID}-3.algolianet.com` These URLs use a different
11+
* DNS provider than the primary URLs. You should randomize this list to ensure an even load across the three servers.
12+
* All Algolia API clients implement this retry strategy. ## Authentication To authenticate your API requests, add
13+
* these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the
14+
* necessary permissions to make the request. The required access control list (ACL) to make a request is listed in
15+
* each endpoint's reference. You can find your application ID and API key in the [Algolia
16+
* dashboard](https://dashboard.algolia.com/account). ## Request format Depending on the endpoint, request bodies are
17+
* either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed as query parameters for GET and
18+
* DELETE requests, and in the request body for POST and PUT requests. Query parameters must be
19+
* [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII characters must be
20+
* UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. Arrays as query parameters must be one of: - A
21+
* comma-separated string: `attributesToRetrieve=title,description` - A URL-encoded JSON array:
22+
* `attributesToRetrieve=%5B%22title%22,%22description%22%D` ## Response status and errors The Composition API returns
23+
* JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API
24+
* response. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are
25+
* indicated by a `5xx` status. Error responses have a `message` property with more information. ## Version The current
26+
* version of the Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
27+
*
28+
* The version of the OpenAPI document: 1.0.0
29+
*
30+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
31+
* https://openapi-generator.tech Do not edit the class manually.
32+
*/
33+
package algoliasearch.composition
34+
35+
/** ExternalInjection
36+
*
37+
* @param objectID
38+
* An objectID injected into an external source.
39+
* @param metadata
40+
* User-defined key-values that will be added to the injected item in the response. This is identical to Hits
41+
* metadata defined in Composition or Composition Rule, with the benefit of being set at runtime.
42+
*/
43+
case class ExternalInjection(
44+
objectID: String,
45+
metadata: Option[Map[String, Any]] = scala.None
46+
)

‎src/main/scala/algoliasearch/composition/Params.scala‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,8 @@ import algoliasearch.composition.SupportedLanguage._
118118
* @param enableReRanking
119119
* Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) This
120120
* setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
121+
* @param injectedItems
122+
* A list of extenrally injected objectID groups into from an external source.
121123
*/
122124
case class Params(
123125
query: Option[String] = scala.None,
@@ -145,5 +147,6 @@ case class Params(
145147
analytics: Option[Boolean] = scala.None,
146148
analyticsTags: Option[Seq[String]] = scala.None,
147149
enableABTest: Option[Boolean] = scala.None,
148-
enableReRanking: Option[Boolean] = scala.None
150+
enableReRanking: Option[Boolean] = scala.None,
151+
injectedItems: Option[Map[String, ExternalInjectedItem]] = scala.None
149152
)

0 commit comments

Comments
 (0)