fix(specs): proper title with linter (generated)

algolia/api-clients-automation#3444 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Pierre Millot <[email protected]>
algolia · Jul 30, 2024 · d9500e7 · d9500e7
1 parent 73cc6ae
commit d9500e7
Show file tree

Hide file tree

Showing 61 changed files with 157 additions and 119 deletions.
diff --git a/packages/algoliasearch/builds/models.ts b/packages/algoliasearch/builds/models.ts
@@ -6,7 +6,6 @@ import {
   AlternativesAsExact,
   Anchoring,
   AroundPrecision,
-  AroundPrecisionFromValueInner,
   AroundRadius,
   AroundRadiusAll,
   AutomaticFacetFilter,
@@ -50,11 +49,12 @@ import {
   PromoteObjectID,
   PromoteObjectIDs,
   QueryType,
+  Range,
   RankingInfo,
   ReRankingApplyFilter,
   Redirect,
   RedirectRuleIndexMetadata,
-  RedirectRuleIndexMetadataData,
+  RedirectRuleIndexData,
   RedirectURL,
   RemoveStopWords,
   RemoveWordsIfNoResults,
@@ -92,7 +92,6 @@ export {
   AlternativesAsExact,
   Anchoring,
   AroundPrecision,
-  AroundPrecisionFromValueInner,
   AroundRadius,
   AroundRadiusAll,
   AutomaticFacetFilter,
@@ -136,11 +135,12 @@ export {
   PromoteObjectID,
   PromoteObjectIDs,
   QueryType,
+  Range,
   RankingInfo,
   ReRankingApplyFilter,
   Redirect,
   RedirectRuleIndexMetadata,
-  RedirectRuleIndexMetadataData,
+  RedirectRuleIndexData,
   RedirectURL,
   RemoveStopWords,
   RemoveWordsIfNoResults,

diff --git a/packages/algoliasearch/lite/model/aroundPrecision.ts b/packages/algoliasearch/lite/model/aroundPrecision.ts
@@ -1,8 +1,8 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { AroundPrecisionFromValueInner } from './aroundPrecisionFromValueInner';
+import type { Range } from './range';
 
 /**
  * Precision of a coordinate-based search in meters to group results with similar distances.  The Geo ranking criterion considers all matches within the same range of distances to be equal.
  */
-export type AroundPrecision = AroundPrecisionFromValueInner[] | number;
+export type AroundPrecision = Range[] | number;
diff --git a/packages/algoliasearch/lite/model/index.ts b/packages/algoliasearch/lite/model/index.ts
@@ -5,7 +5,6 @@ export * from './advancedSyntaxFeatures';
 export * from './alternativesAsExact';
 export * from './apiKey';
 export * from './aroundPrecision';
-export * from './aroundPrecisionFromValueInner';
 export * from './aroundRadius';
 export * from './aroundRadiusAll';
 export * from './automaticFacetFilter';
@@ -58,6 +57,7 @@ export * from './optionalFilters';
 export * from './params';
 export * from './personalization';
 export * from './queryType';
+export * from './range';
 export * from './rankingInfo';
 export * from './reRankingApplyFilter';
 export * from './recommendHit';
@@ -69,8 +69,8 @@ export * from './recommendedForYou';
 export * from './recommendedForYouModel';
 export * from './recommendedForYouQuery';
 export * from './redirect';
+export * from './redirectRuleIndexData';
 export * from './redirectRuleIndexMetadata';
-export * from './redirectRuleIndexMetadataData';
 export * from './redirectURL';
 export * from './relatedModel';
 export * from './relatedProducts';

diff --git a/...te/model/aroundPrecisionFromValueInner.ts → packages/algoliasearch/lite/model/range.ts b/...te/model/aroundPrecisionFromValueInner.ts → packages/algoliasearch/lite/model/range.ts
@@ -3,7 +3,7 @@
 /**
  * Range object with lower and upper values in meters to define custom ranges.
  */
-export type AroundPrecisionFromValueInner = {
+export type Range = {
   /**
    * Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
    */

diff --git a/...ch/model/redirectRuleIndexMetadataData.ts → ...earch/lite/model/redirectRuleIndexData.ts b/...ch/model/redirectRuleIndexMetadataData.ts → ...earch/lite/model/redirectRuleIndexData.ts
@@ -3,6 +3,6 @@
 /**
  * Redirect rule data.
  */
-export type RedirectRuleIndexMetadataData = {
+export type RedirectRuleIndexData = {
   ruleObjectID: string;
 };
diff --git a/packages/algoliasearch/lite/model/redirectRuleIndexMetadata.ts b/packages/algoliasearch/lite/model/redirectRuleIndexMetadata.ts
@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { RedirectRuleIndexMetadataData } from './redirectRuleIndexMetadataData';
+import type { RedirectRuleIndexData } from './redirectRuleIndexData';
 
 export type RedirectRuleIndexMetadata = {
   /**
@@ -23,5 +23,5 @@ export type RedirectRuleIndexMetadata = {
    */
   succeed: boolean;
 
-  data: RedirectRuleIndexMetadataData;
+  data: RedirectRuleIndexData;
 };
diff --git a/...testing/model/filterEffectsEmptySearch.ts → ...ient-abtesting/model/emptySearchFilter.ts b/...testing/model/filterEffectsEmptySearch.ts → ...ient-abtesting/model/emptySearchFilter.ts
@@ -3,7 +3,7 @@
 /**
  * Empty searches removed from the A/B test as a result of configuration settings.
  */
-export type FilterEffectsEmptySearch = {
+export type EmptySearchFilter = {
   /**
    * Number of users removed from the A/B test.
    */

diff --git a/packages/client-abtesting/model/filterEffects.ts b/packages/client-abtesting/model/filterEffects.ts
@@ -1,13 +1,13 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { FilterEffectsEmptySearch } from './filterEffectsEmptySearch';
-import type { FilterEffectsOutliers } from './filterEffectsOutliers';
+import type { EmptySearchFilter } from './emptySearchFilter';
+import type { OutliersFilter } from './outliersFilter';
 
 /**
  * A/B test filter effects resulting from configuration settings.
  */
 export type FilterEffects = {
-  outliers?: FilterEffectsOutliers;
+  outliers?: OutliersFilter;
 
-  emptySearch?: FilterEffectsEmptySearch;
+  emptySearch?: EmptySearchFilter;
 };
diff --git a/packages/client-abtesting/model/index.ts b/packages/client-abtesting/model/index.ts
@@ -11,13 +11,13 @@ export * from './currency';
 export * from './customSearchParams';
 export * from './effect';
 export * from './emptySearch';
+export * from './emptySearchFilter';
 export * from './errorBase';
 export * from './filterEffects';
-export * from './filterEffectsEmptySearch';
-export * from './filterEffectsOutliers';
 export * from './listABTestsResponse';
 export * from './minimumDetectableEffect';
 export * from './outliers';
+export * from './outliersFilter';
 export * from './status';
 export * from './variant';
 export * from './clientMethodProps';
diff --git a/...-abtesting/model/filterEffectsOutliers.ts → .../client-abtesting/model/outliersFilter.ts b/...-abtesting/model/filterEffectsOutliers.ts → .../client-abtesting/model/outliersFilter.ts
@@ -3,7 +3,7 @@
 /**
  * Outliers removed from the A/B test as a result of configuration settings.
  */
-export type FilterEffectsOutliers = {
+export type OutliersFilter = {
   /**
    * Number of users removed from the A/B test.
    */

diff --git a/...nt-analytics/model/clickPositionsInner.ts → ...s/client-analytics/model/clickPosition.ts b/...nt-analytics/model/clickPositionsInner.ts → ...s/client-analytics/model/clickPosition.ts
@@ -3,7 +3,7 @@
 /**
  * Click position.
  */
-export type ClickPositionsInner = {
+export type ClickPosition = {
   /**
    * Range of positions in the search results, using the pattern `[start,end]`.  For positions 11 and up, click events are summed over the specified range. `-1` indicates the end of the list of search results.
    */

diff --git a/packages/client-analytics/model/getClickPositionsResponse.ts b/packages/client-analytics/model/getClickPositionsResponse.ts
@@ -1,10 +1,10 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { ClickPositionsInner } from './clickPositionsInner';
+import type { ClickPosition } from './clickPosition';
 
 export type GetClickPositionsResponse = {
   /**
    * List of positions in the search results and clicks associated with this search.
    */
-  positions: ClickPositionsInner[];
+  positions: ClickPosition[];
 };
diff --git a/packages/client-analytics/model/index.ts b/packages/client-analytics/model/index.ts
@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-export * from './clickPositionsInner';
+export * from './clickPosition';
 export * from './currenciesValue';
 export * from './dailyAddToCartRates';
 export * from './dailyAverageClicks';

diff --git a/packages/client-analytics/model/topSearchWithAnalytics.ts b/packages/client-analytics/model/topSearchWithAnalytics.ts
@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { ClickPositionsInner } from './clickPositionsInner';
+import type { ClickPosition } from './clickPosition';
 
 export type TopSearchWithAnalytics = {
   /**
@@ -26,7 +26,7 @@ export type TopSearchWithAnalytics = {
   /**
    * List of positions in the search results and clicks associated with this search.
    */
-  clickPositions: ClickPositionsInner[];
+  clickPositions: ClickPosition[];
 
   /**
    * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.

diff --git a/packages/client-analytics/model/topSearchWithRevenueAnalytics.ts b/packages/client-analytics/model/topSearchWithRevenueAnalytics.ts
@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { ClickPositionsInner } from './clickPositionsInner';
+import type { ClickPosition } from './clickPosition';
 import type { CurrenciesValue } from './currenciesValue';
 
 export type TopSearchWithRevenueAnalytics = {
@@ -27,7 +27,7 @@ export type TopSearchWithRevenueAnalytics = {
   /**
    * List of positions in the search results and clicks associated with this search.
    */
-  clickPositions: ClickPositionsInner[];
+  clickPositions: ClickPosition[];
 
   /**
    * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.

diff --git a/...tions/model/getConfigStatus200Response.ts → ...t-query-suggestions/model/configStatus.ts b/...tions/model/getConfigStatus200Response.ts → ...t-query-suggestions/model/configStatus.ts
@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-export type GetConfigStatus200Response = {
+export type ConfigStatus = {
   /**
    * Name of the Query Suggestions index (case-sensitive).
    */

diff --git a/packages/client-query-suggestions/model/index.ts b/packages/client-query-suggestions/model/index.ts
@@ -2,14 +2,14 @@
 
 export * from './appID';
 export * from './baseResponse';
+export * from './configStatus';
 export * from './configuration';
 export * from './configurationResponse';
 export * from './configurationWithIndex';
 export * from './errorBase';
 export * from './facet';
-export * from './getConfigStatus200Response';
-export * from './getLogFile200Response';
 export * from './languages';
+export * from './logFile';
 export * from './logLevel';
 export * from './sourceIndex';
 export * from './clientMethodProps';
diff --git a/...uggestions/model/getLogFile200Response.ts → ...client-query-suggestions/model/logFile.ts b/...uggestions/model/getLogFile200Response.ts → ...client-query-suggestions/model/logFile.ts
@@ -2,7 +2,7 @@
 
 import type { LogLevel } from './logLevel';
 
-export type GetLogFile200Response = {
+export type LogFile = {
   /**
    * Date and time of the log entry, in RFC 3339 format.
    */

diff --git a/packages/client-query-suggestions/src/querySuggestionsClient.ts b/packages/client-query-suggestions/src/querySuggestionsClient.ts
@@ -26,10 +26,10 @@ import type {
   GetLogFileProps,
   UpdateConfigProps,
 } from '../model/clientMethodProps';
+import type { ConfigStatus } from '../model/configStatus';
 import type { ConfigurationResponse } from '../model/configurationResponse';
 import type { ConfigurationWithIndex } from '../model/configurationWithIndex';
-import type { GetConfigStatus200Response } from '../model/getConfigStatus200Response';
-import type { GetLogFile200Response } from '../model/getLogFile200Response';
+import type { LogFile } from '../model/logFile';
 
 export const apiClientVersion = '5.0.0-beta.12';
 
@@ -387,7 +387,7 @@ export function createQuerySuggestionsClient({
     getConfigStatus(
       { indexName }: GetConfigStatusProps,
       requestOptions?: RequestOptions
-    ): Promise<GetConfigStatus200Response> {
+    ): Promise<ConfigStatus> {
       if (!indexName) {
         throw new Error(
           'Parameter `indexName` is required when calling `getConfigStatus`.'
@@ -424,7 +424,7 @@ export function createQuerySuggestionsClient({
     getLogFile(
       { indexName }: GetLogFileProps,
       requestOptions?: RequestOptions
-    ): Promise<GetLogFile200Response> {
+    ): Promise<LogFile> {
       if (!indexName) {
         throw new Error(
           'Parameter `indexName` is required when calling `getLogFile`.'

diff --git a/packages/client-search/model/aroundPrecision.ts b/packages/client-search/model/aroundPrecision.ts
@@ -1,8 +1,8 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { AroundPrecisionFromValueInner } from './aroundPrecisionFromValueInner';
+import type { Range } from './range';
 
 /**
  * Precision of a coordinate-based search in meters to group results with similar distances.  The Geo ranking criterion considers all matches within the same range of distances to be equal.
  */
-export type AroundPrecision = AroundPrecisionFromValueInner[] | number;
+export type AroundPrecision = Range[] | number;
diff --git a/packages/client-search/model/index.ts b/packages/client-search/model/index.ts
@@ -9,7 +9,6 @@ export * from './anchoring';
 export * from './apiKey';
 export * from './apiKeyOperation';
 export * from './aroundPrecision';
-export * from './aroundPrecisionFromValueInner';
 export * from './aroundRadius';
 export * from './aroundRadiusAll';
 export * from './assignUserIdParams';
@@ -102,11 +101,12 @@ export * from './promote';
 export * from './promoteObjectID';
 export * from './promoteObjectIDs';
 export * from './queryType';
+export * from './range';
 export * from './rankingInfo';
 export * from './reRankingApplyFilter';
 export * from './redirect';
+export * from './redirectRuleIndexData';
 export * from './redirectRuleIndexMetadata';
-export * from './redirectRuleIndexMetadataData';
 export * from './redirectURL';
 export * from './removeStopWords';
 export * from './removeUserIdResponse';

diff --git a/...ch/model/aroundPrecisionFromValueInner.ts → packages/client-search/model/range.ts b/...ch/model/aroundPrecisionFromValueInner.ts → packages/client-search/model/range.ts
@@ -3,7 +3,7 @@
 /**
  * Range object with lower and upper values in meters to define custom ranges.
  */
-export type AroundPrecisionFromValueInner = {
+export type Range = {
   /**
    * Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
    */

diff --git a/...te/model/redirectRuleIndexMetadataData.ts → ...ent-search/model/redirectRuleIndexData.ts b/...te/model/redirectRuleIndexMetadataData.ts → ...ent-search/model/redirectRuleIndexData.ts
@@ -3,6 +3,6 @@
 /**
  * Redirect rule data.
  */
-export type RedirectRuleIndexMetadataData = {
+export type RedirectRuleIndexData = {
   ruleObjectID: string;
 };
diff --git a/packages/client-search/model/redirectRuleIndexMetadata.ts b/packages/client-search/model/redirectRuleIndexMetadata.ts
@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { RedirectRuleIndexMetadataData } from './redirectRuleIndexMetadataData';
+import type { RedirectRuleIndexData } from './redirectRuleIndexData';
 
 export type RedirectRuleIndexMetadata = {
   /**
@@ -23,5 +23,5 @@ export type RedirectRuleIndexMetadata = {
    */
   succeed: boolean;
 
-  data: RedirectRuleIndexMetadataData;
+  data: RedirectRuleIndexData;
 };
diff --git a/packages/client-search/model/searchParamsString.ts b/packages/client-search/model/searchParamsString.ts
@@ -1,5 +1,8 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
+/**
+ * Search parameters as query string.
+ */
 export type SearchParamsString = {
   /**
    * Search parameters as a URL-encoded query string.

diff --git a/...el/getUsage400ResponseErrorErrorsInner.ts → packages/client-usage/model/errorItem.ts b/...el/getUsage400ResponseErrorErrorsInner.ts → packages/client-usage/model/errorItem.ts
@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-export type GetUsage400ResponseErrorErrorsInner = {
+export type ErrorItem = {
   code?: string;
 
   message: string;

diff --git a/packages/client-usage/model/forbidden.ts b/packages/client-usage/model/forbidden.ts
@@ -0,0 +1,7 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { ForbiddenError } from './forbiddenError';
+
+export type Forbidden = {
+  error: ForbiddenError;
+};
diff --git a/...ring/model/indexingTimeResponseMetrics.ts → ...ages/client-usage/model/forbiddenError.ts b/...ring/model/indexingTimeResponseMetrics.ts → ...ages/client-usage/model/forbiddenError.ts
@@ -1,7 +1,11 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { TimeInner } from './timeInner';
+import type { ErrorItem } from './errorItem';
 
-export type IndexingTimeResponseMetrics = {
-  indexing?: Record<string, TimeInner[]>;
+export type ForbiddenError = {
+  code?: string;
+
+  message?: string;
+
+  errors?: ErrorItem[];
 };