Skip to content

Commit

Permalink
fix(specs): responseFields description (generated)
Browse files Browse the repository at this point in the history
algolia/api-clients-automation#4399

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
  • Loading branch information
algolia-bot and kai687 committed Jan 24, 2025
1 parent dec9310 commit f2b618a
Show file tree
Hide file tree
Showing 12 changed files with 84 additions and 60 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -156,11 +156,13 @@ import algoliasearch.recommend.SupportedLanguage._
* by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
* matches with one word between them would have the same score.
* @param responseFields
* Properties to include in the API response of `search` and `browse` requests. By default, all response properties
* are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
* these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
* any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
* search UI.
* Properties to include in the API response of search and browse requests. By default, all response properties are
* included. To reduce the response size, you can select which properties should be included. An empty list may lead
* to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
* `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
* depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
* on other properties, for example, for pagination. Before restricting the response size, check the impact on your
* search experience.
* @param maxValuesPerFacet
* Maximum number of facet values to return for each facet.
* @param sortFacetValuesBy
Expand Down
12 changes: 7 additions & 5 deletions src/main/scala/algoliasearch/recommend/FallbackParams.scala
Original file line number Diff line number Diff line change
Expand Up @@ -360,11 +360,13 @@ import algoliasearch.recommend.SupportedLanguage._
* by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
* matches with one word between them would have the same score.
* @param responseFields
* Properties to include in the API response of `search` and `browse` requests. By default, all response properties
* are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
* these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
* any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
* search UI.
* Properties to include in the API response of search and browse requests. By default, all response properties are
* included. To reduce the response size, you can select which properties should be included. An empty list may lead
* to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
* `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
* depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
* on other properties, for example, for pagination. Before restricting the response size, check the impact on your
* search experience.
* @param maxValuesPerFacet
* Maximum number of facet values to return for each facet.
* @param sortFacetValuesBy
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -275,11 +275,13 @@ import algoliasearch.recommend.SupportedLanguage._
* by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
* matches with one word between them would have the same score.
* @param responseFields
* Properties to include in the API response of `search` and `browse` requests. By default, all response properties
* are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
* these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
* any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
* search UI.
* Properties to include in the API response of search and browse requests. By default, all response properties are
* included. To reduce the response size, you can select which properties should be included. An empty list may lead
* to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
* `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
* depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
* on other properties, for example, for pagination. Before restricting the response size, check the impact on your
* search experience.
* @param maxValuesPerFacet
* Maximum number of facet values to return for each facet.
* @param sortFacetValuesBy
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -360,11 +360,13 @@ import algoliasearch.recommend.SupportedLanguage._
* by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
* matches with one word between them would have the same score.
* @param responseFields
* Properties to include in the API response of `search` and `browse` requests. By default, all response properties
* are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
* these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
* any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
* search UI.
* Properties to include in the API response of search and browse requests. By default, all response properties are
* included. To reduce the response size, you can select which properties should be included. An empty list may lead
* to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
* `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
* depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
* on other properties, for example, for pagination. Before restricting the response size, check the impact on your
* search experience.
* @param maxValuesPerFacet
* Maximum number of facet values to return for each facet.
* @param sortFacetValuesBy
Expand Down
12 changes: 7 additions & 5 deletions src/main/scala/algoliasearch/search/BrowseParamsObject.scala
Original file line number Diff line number Diff line change
Expand Up @@ -254,11 +254,13 @@ import algoliasearch.search.SupportedLanguage._
* by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
* matches with one word between them would have the same score.
* @param responseFields
* Properties to include in the API response of `search` and `browse` requests. By default, all response properties
* are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
* these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
* any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
* search UI.
* Properties to include in the API response of search and browse requests. By default, all response properties are
* included. To reduce the response size, you can select which properties should be included. An empty list may lead
* to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
* `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
* depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
* on other properties, for example, for pagination. Before restricting the response size, check the impact on your
* search experience.
* @param maxValuesPerFacet
* Maximum number of facet values to return for each facet.
* @param sortFacetValuesBy
Expand Down
12 changes: 7 additions & 5 deletions src/main/scala/algoliasearch/search/ConsequenceParams.scala
Original file line number Diff line number Diff line change
Expand Up @@ -252,11 +252,13 @@ import algoliasearch.search.SupportedLanguage._
* by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
* matches with one word between them would have the same score.
* @param responseFields
* Properties to include in the API response of `search` and `browse` requests. By default, all response properties
* are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
* these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
* any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
* search UI.
* Properties to include in the API response of search and browse requests. By default, all response properties are
* included. To reduce the response size, you can select which properties should be included. An empty list may lead
* to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
* `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
* depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
* on other properties, for example, for pagination. Before restricting the response size, check the impact on your
* search experience.
* @param maxValuesPerFacet
* Maximum number of facet values to return for each facet.
* @param sortFacetValuesBy
Expand Down
12 changes: 7 additions & 5 deletions src/main/scala/algoliasearch/search/IndexSettings.scala
Original file line number Diff line number Diff line change
Expand Up @@ -282,11 +282,13 @@ import algoliasearch.search.SupportedLanguage._
* by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
* matches with one word between them would have the same score.
* @param responseFields
* Properties to include in the API response of `search` and `browse` requests. By default, all response properties
* are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
* these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
* any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
* search UI.
* Properties to include in the API response of search and browse requests. By default, all response properties are
* included. To reduce the response size, you can select which properties should be included. An empty list may lead
* to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
* `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
* depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
* on other properties, for example, for pagination. Before restricting the response size, check the impact on your
* search experience.
* @param maxValuesPerFacet
* Maximum number of facet values to return for each facet.
* @param sortFacetValuesBy
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,11 +163,13 @@ import algoliasearch.search.SupportedLanguage._
* by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
* matches with one word between them would have the same score.
* @param responseFields
* Properties to include in the API response of `search` and `browse` requests. By default, all response properties
* are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
* these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
* any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
* search UI.
* Properties to include in the API response of search and browse requests. By default, all response properties are
* included. To reduce the response size, you can select which properties should be included. An empty list may lead
* to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
* `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
* depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
* on other properties, for example, for pagination. Before restricting the response size, check the impact on your
* search experience.
* @param maxValuesPerFacet
* Maximum number of facet values to return for each facet.
* @param sortFacetValuesBy
Expand Down
12 changes: 7 additions & 5 deletions src/main/scala/algoliasearch/search/SearchForFacets.scala
Original file line number Diff line number Diff line change
Expand Up @@ -257,11 +257,13 @@ import algoliasearch.search.SupportedLanguage._
* by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
* matches with one word between them would have the same score.
* @param responseFields
* Properties to include in the API response of `search` and `browse` requests. By default, all response properties
* are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
* these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
* any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
* search UI.
* Properties to include in the API response of search and browse requests. By default, all response properties are
* included. To reduce the response size, you can select which properties should be included. An empty list may lead
* to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
* `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
* depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
* on other properties, for example, for pagination. Before restricting the response size, check the impact on your
* search experience.
* @param maxValuesPerFacet
* Maximum number of facet values to return for each facet.
* @param sortFacetValuesBy
Expand Down
12 changes: 7 additions & 5 deletions src/main/scala/algoliasearch/search/SearchForHits.scala
Original file line number Diff line number Diff line change
Expand Up @@ -257,11 +257,13 @@ import algoliasearch.search.SupportedLanguage._
* by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
* matches with one word between them would have the same score.
* @param responseFields
* Properties to include in the API response of `search` and `browse` requests. By default, all response properties
* are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
* these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
* any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
* search UI.
* Properties to include in the API response of search and browse requests. By default, all response properties are
* included. To reduce the response size, you can select which properties should be included. An empty list may lead
* to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
* `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
* depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
* on other properties, for example, for pagination. Before restricting the response size, check the impact on your
* search experience.
* @param maxValuesPerFacet
* Maximum number of facet values to return for each facet.
* @param sortFacetValuesBy
Expand Down
12 changes: 7 additions & 5 deletions src/main/scala/algoliasearch/search/SearchParamsObject.scala
Original file line number Diff line number Diff line change
Expand Up @@ -254,11 +254,13 @@ import algoliasearch.search.SupportedLanguage._
* by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
* matches with one word between them would have the same score.
* @param responseFields
* Properties to include in the API response of `search` and `browse` requests. By default, all response properties
* are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
* these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
* any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
* search UI.
* Properties to include in the API response of search and browse requests. By default, all response properties are
* included. To reduce the response size, you can select which properties should be included. An empty list may lead
* to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
* `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
* depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
* on other properties, for example, for pagination. Before restricting the response size, check the impact on your
* search experience.
* @param maxValuesPerFacet
* Maximum number of facet values to return for each facet.
* @param sortFacetValuesBy
Expand Down
12 changes: 7 additions & 5 deletions src/main/scala/algoliasearch/search/SettingsResponse.scala
Original file line number Diff line number Diff line change
Expand Up @@ -282,11 +282,13 @@ import algoliasearch.search.SupportedLanguage._
* by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
* matches with one word between them would have the same score.
* @param responseFields
* Properties to include in the API response of `search` and `browse` requests. By default, all response properties
* are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
* these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
* any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
* search UI.
* Properties to include in the API response of search and browse requests. By default, all response properties are
* included. To reduce the response size, you can select which properties should be included. An empty list may lead
* to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
* `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
* depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
* on other properties, for example, for pagination. Before restricting the response size, check the impact on your
* search experience.
* @param maxValuesPerFacet
* Maximum number of facet values to return for each facet.
* @param sortFacetValuesBy
Expand Down

0 comments on commit f2b618a

Please sign in to comment.