Skip to content

Commit f7b7f59

Browse files
fix(specs): Comp API overview is not accurate for Parameters section (generated)
algolia/api-clients-automation#5685 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]> Co-authored-by: algolia-bot <[email protected]>
1 parent 9908315 commit f7b7f59

File tree

116 files changed

+580
-812
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

116 files changed

+580
-812
lines changed

src/main/scala/algoliasearch/composition/Action.scala

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,11 @@
1515
* each endpoint's reference. You can find your application ID and API key in the [Algolia
1616
* dashboard](https://dashboard.algolia.com/account/api-keys). ## Request format Depending on the endpoint, request
1717
* bodies are either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed in the request body
18-
* 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. ## Response status and errors The Composition API
21-
* returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in
22-
* the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are
23-
* indicated by a `5xx` status. Error responses have a `message` property with more information. ## Version The current
24-
* version of the Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
18+
* for POST and PUT requests. ## Response status and errors The Composition API returns JSON responses. Since JSON
19+
* doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful
20+
* responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.
21+
* Error responses have a `message` property with more information. ## Version The current version of the Composition
22+
* API is version 1, as indicated by the `/1/` in each endpoint's URL.
2523
*
2624
* The version of the OpenAPI document: 1.0.0
2725
*

src/main/scala/algoliasearch/composition/AdvancedSyntaxFeatures.scala

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,11 @@
1515
* each endpoint's reference. You can find your application ID and API key in the [Algolia
1616
* dashboard](https://dashboard.algolia.com/account/api-keys). ## Request format Depending on the endpoint, request
1717
* bodies are either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed in the request body
18-
* 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. ## Response status and errors The Composition API
21-
* returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in
22-
* the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are
23-
* indicated by a `5xx` status. Error responses have a `message` property with more information. ## Version The current
24-
* version of the Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
18+
* for POST and PUT requests. ## Response status and errors The Composition API returns JSON responses. Since JSON
19+
* doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful
20+
* responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.
21+
* Error responses have a `message` property with more information. ## Version The current version of the Composition
22+
* API is version 1, as indicated by the `/1/` in each endpoint's URL.
2523
*
2624
* The version of the OpenAPI document: 1.0.0
2725
*

src/main/scala/algoliasearch/composition/AlternativesAsExact.scala

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,11 @@
1515
* each endpoint's reference. You can find your application ID and API key in the [Algolia
1616
* dashboard](https://dashboard.algolia.com/account/api-keys). ## Request format Depending on the endpoint, request
1717
* bodies are either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed in the request body
18-
* 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. ## Response status and errors The Composition API
21-
* returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in
22-
* the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are
23-
* indicated by a `5xx` status. Error responses have a `message` property with more information. ## Version The current
24-
* version of the Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
18+
* for POST and PUT requests. ## Response status and errors The Composition API returns JSON responses. Since JSON
19+
* doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful
20+
* responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.
21+
* Error responses have a `message` property with more information. ## Version The current version of the Composition
22+
* API is version 1, as indicated by the `/1/` in each endpoint's URL.
2523
*
2624
* The version of the OpenAPI document: 1.0.0
2725
*

src/main/scala/algoliasearch/composition/Anchoring.scala

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,11 @@
1515
* each endpoint's reference. You can find your application ID and API key in the [Algolia
1616
* dashboard](https://dashboard.algolia.com/account/api-keys). ## Request format Depending on the endpoint, request
1717
* bodies are either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed in the request body
18-
* 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. ## Response status and errors The Composition API
21-
* returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in
22-
* the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are
23-
* indicated by a `5xx` status. Error responses have a `message` property with more information. ## Version The current
24-
* version of the Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
18+
* for POST and PUT requests. ## Response status and errors The Composition API returns JSON responses. Since JSON
19+
* doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful
20+
* responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.
21+
* Error responses have a `message` property with more information. ## Version The current version of the Composition
22+
* API is version 1, as indicated by the `/1/` in each endpoint's URL.
2523
*
2624
* The version of the OpenAPI document: 1.0.0
2725
*

src/main/scala/algoliasearch/composition/AroundPrecision.scala

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,11 @@
1515
* each endpoint's reference. You can find your application ID and API key in the [Algolia
1616
* dashboard](https://dashboard.algolia.com/account/api-keys). ## Request format Depending on the endpoint, request
1717
* bodies are either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed in the request body
18-
* 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. ## Response status and errors The Composition API
21-
* returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in
22-
* the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are
23-
* indicated by a `5xx` status. Error responses have a `message` property with more information. ## Version The current
24-
* version of the Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
18+
* for POST and PUT requests. ## Response status and errors The Composition API returns JSON responses. Since JSON
19+
* doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful
20+
* responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.
21+
* Error responses have a `message` property with more information. ## Version The current version of the Composition
22+
* API is version 1, as indicated by the `/1/` in each endpoint's URL.
2523
*
2624
* The version of the OpenAPI document: 1.0.0
2725
*

src/main/scala/algoliasearch/composition/AroundRadius.scala

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,11 @@
1515
* each endpoint's reference. You can find your application ID and API key in the [Algolia
1616
* dashboard](https://dashboard.algolia.com/account/api-keys). ## Request format Depending on the endpoint, request
1717
* bodies are either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed in the request body
18-
* 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. ## Response status and errors The Composition API
21-
* returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in
22-
* the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are
23-
* indicated by a `5xx` status. Error responses have a `message` property with more information. ## Version The current
24-
* version of the Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
18+
* for POST and PUT requests. ## Response status and errors The Composition API returns JSON responses. Since JSON
19+
* doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful
20+
* responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.
21+
* Error responses have a `message` property with more information. ## Version The current version of the Composition
22+
* API is version 1, as indicated by the `/1/` in each endpoint's URL.
2523
*
2624
* The version of the OpenAPI document: 1.0.0
2725
*

src/main/scala/algoliasearch/composition/AroundRadiusAll.scala

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,11 @@
1515
* each endpoint's reference. You can find your application ID and API key in the [Algolia
1616
* dashboard](https://dashboard.algolia.com/account/api-keys). ## Request format Depending on the endpoint, request
1717
* bodies are either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed in the request body
18-
* 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. ## Response status and errors The Composition API
21-
* returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in
22-
* the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are
23-
* indicated by a `5xx` status. Error responses have a `message` property with more information. ## Version The current
24-
* version of the Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
18+
* for POST and PUT requests. ## Response status and errors The Composition API returns JSON responses. Since JSON
19+
* doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful
20+
* responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.
21+
* Error responses have a `message` property with more information. ## Version The current version of the Composition
22+
* API is version 1, as indicated by the `/1/` in each endpoint's URL.
2523
*
2624
* The version of the OpenAPI document: 1.0.0
2725
*

src/main/scala/algoliasearch/composition/Banner.scala

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,11 @@
1515
* each endpoint's reference. You can find your application ID and API key in the [Algolia
1616
* dashboard](https://dashboard.algolia.com/account/api-keys). ## Request format Depending on the endpoint, request
1717
* bodies are either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed in the request body
18-
* 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. ## Response status and errors The Composition API
21-
* returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in
22-
* the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are
23-
* indicated by a `5xx` status. Error responses have a `message` property with more information. ## Version The current
24-
* version of the Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
18+
* for POST and PUT requests. ## Response status and errors The Composition API returns JSON responses. Since JSON
19+
* doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful
20+
* responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.
21+
* Error responses have a `message` property with more information. ## Version The current version of the Composition
22+
* API is version 1, as indicated by the `/1/` in each endpoint's URL.
2523
*
2624
* The version of the OpenAPI document: 1.0.0
2725
*

src/main/scala/algoliasearch/composition/BannerImage.scala

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,11 @@
1515
* each endpoint's reference. You can find your application ID and API key in the [Algolia
1616
* dashboard](https://dashboard.algolia.com/account/api-keys). ## Request format Depending on the endpoint, request
1717
* bodies are either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed in the request body
18-
* 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. ## Response status and errors The Composition API
21-
* returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in
22-
* the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are
23-
* indicated by a `5xx` status. Error responses have a `message` property with more information. ## Version The current
24-
* version of the Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
18+
* for POST and PUT requests. ## Response status and errors The Composition API returns JSON responses. Since JSON
19+
* doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful
20+
* responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.
21+
* Error responses have a `message` property with more information. ## Version The current version of the Composition
22+
* API is version 1, as indicated by the `/1/` in each endpoint's URL.
2523
*
2624
* The version of the OpenAPI document: 1.0.0
2725
*

src/main/scala/algoliasearch/composition/BannerImageUrl.scala

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,11 @@
1515
* each endpoint's reference. You can find your application ID and API key in the [Algolia
1616
* dashboard](https://dashboard.algolia.com/account/api-keys). ## Request format Depending on the endpoint, request
1717
* bodies are either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed in the request body
18-
* 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. ## Response status and errors The Composition API
21-
* returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in
22-
* the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are
23-
* indicated by a `5xx` status. Error responses have a `message` property with more information. ## Version The current
24-
* version of the Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
18+
* for POST and PUT requests. ## Response status and errors The Composition API returns JSON responses. Since JSON
19+
* doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful
20+
* responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.
21+
* Error responses have a `message` property with more information. ## Version The current version of the Composition
22+
* API is version 1, as indicated by the `/1/` in each endpoint's URL.
2523
*
2624
* The version of the OpenAPI document: 1.0.0
2725
*

0 commit comments

Comments
 (0)