From ceac816b08824114944f50d6a743ccb241a6b900 Mon Sep 17 00:00:00 2001 From: Eunjae Lee Date: Tue, 25 Jan 2022 17:04:59 +0100 Subject: [PATCH 1/2] fix: add version to user agent --- .../client-abtesting/src/abtestingApi.ts | 4 +++- .../client-analytics/src/analyticsApi.ts | 4 +++- .../client-insights/src/insightsApi.ts | 4 +++- .../src/personalizationApi.ts | 4 +++- .../src/querySuggestionsApi.ts | 4 +++- .../client-search/src/searchApi.ts | 4 +++- .../client-sources/src/sourcesApi.ts | 4 +++- .../recommend/src/recommendApi.ts | 4 +++- openapitools.json | 16 ++++++++-------- templates/javascript/api-single.mustache | 4 +++- templates/javascript/package.mustache | 2 +- 11 files changed, 36 insertions(+), 18 deletions(-) diff --git a/clients/algoliasearch-client-javascript/client-abtesting/src/abtestingApi.ts b/clients/algoliasearch-client-javascript/client-abtesting/src/abtestingApi.ts index c694b0eb9be..df53a2ef02b 100644 --- a/clients/algoliasearch-client-javascript/client-abtesting/src/abtestingApi.ts +++ b/clients/algoliasearch-client-javascript/client-abtesting/src/abtestingApi.ts @@ -12,6 +12,8 @@ import type { ABTestResponse } from '../model/aBTestResponse'; import type { AddABTestsRequest } from '../model/addABTestsRequest'; import type { ListABTestsResponse } from '../model/listABTestsResponse'; +export const version = '5.0.0'; + export class AbtestingApi { protected authentications = { apiKey: 'Algolia-API-Key', @@ -60,7 +62,7 @@ export class AbtestingApi { baseHeaders: { 'content-type': 'application/x-www-form-urlencoded', }, - userAgent: 'Algolia for Javascript', + userAgent: 'Algolia for Javascript 5.0.0', timeouts: { connect: 2, read: 5, diff --git a/clients/algoliasearch-client-javascript/client-analytics/src/analyticsApi.ts b/clients/algoliasearch-client-javascript/client-analytics/src/analyticsApi.ts index 4d09971ddb3..ff24ed30fac 100644 --- a/clients/algoliasearch-client-javascript/client-analytics/src/analyticsApi.ts +++ b/clients/algoliasearch-client-javascript/client-analytics/src/analyticsApi.ts @@ -27,6 +27,8 @@ import type { GetTopSearchesResponse } from '../model/getTopSearchesResponse'; import type { GetTopSearchesResponseWithAnalytics } from '../model/getTopSearchesResponseWithAnalytics'; import type { GetUsersCountResponse } from '../model/getUsersCountResponse'; +export const version = '5.0.0'; + export class AnalyticsApi { protected authentications = { apiKey: 'Algolia-API-Key', @@ -75,7 +77,7 @@ export class AnalyticsApi { baseHeaders: { 'content-type': 'application/x-www-form-urlencoded', }, - userAgent: 'Algolia for Javascript', + userAgent: 'Algolia for Javascript 5.0.0', timeouts: { connect: 2, read: 5, diff --git a/clients/algoliasearch-client-javascript/client-insights/src/insightsApi.ts b/clients/algoliasearch-client-javascript/client-insights/src/insightsApi.ts index 35cbcac7dab..100f3fedbb3 100644 --- a/clients/algoliasearch-client-javascript/client-insights/src/insightsApi.ts +++ b/clients/algoliasearch-client-javascript/client-insights/src/insightsApi.ts @@ -10,6 +10,8 @@ import type { import type { InsightEvents } from '../model/insightEvents'; import type { PushEventsResponse } from '../model/pushEventsResponse'; +export const version = '5.0.0'; + export class InsightsApi { protected authentications = { apiKey: 'Algolia-API-Key', @@ -57,7 +59,7 @@ export class InsightsApi { baseHeaders: { 'content-type': 'application/x-www-form-urlencoded', }, - userAgent: 'Algolia for Javascript', + userAgent: 'Algolia for Javascript 5.0.0', timeouts: { connect: 2, read: 5, diff --git a/clients/algoliasearch-client-javascript/client-personalization/src/personalizationApi.ts b/clients/algoliasearch-client-javascript/client-personalization/src/personalizationApi.ts index 079eaa354d4..3088333fab6 100644 --- a/clients/algoliasearch-client-javascript/client-personalization/src/personalizationApi.ts +++ b/clients/algoliasearch-client-javascript/client-personalization/src/personalizationApi.ts @@ -12,6 +12,8 @@ import type { GetUserTokenResponse } from '../model/getUserTokenResponse'; import type { PersonalizationStrategyParams } from '../model/personalizationStrategyParams'; import type { SetPersonalizationStrategyResponse } from '../model/setPersonalizationStrategyResponse'; +export const version = '5.0.0'; + export class PersonalizationApi { protected authentications = { apiKey: 'Algolia-API-Key', @@ -60,7 +62,7 @@ export class PersonalizationApi { baseHeaders: { 'content-type': 'application/x-www-form-urlencoded', }, - userAgent: 'Algolia for Javascript', + userAgent: 'Algolia for Javascript 5.0.0', timeouts: { connect: 2, read: 5, diff --git a/clients/algoliasearch-client-javascript/client-query-suggestions/src/querySuggestionsApi.ts b/clients/algoliasearch-client-javascript/client-query-suggestions/src/querySuggestionsApi.ts index 859e6636d8d..bd75192dd72 100644 --- a/clients/algoliasearch-client-javascript/client-query-suggestions/src/querySuggestionsApi.ts +++ b/clients/algoliasearch-client-javascript/client-query-suggestions/src/querySuggestionsApi.ts @@ -14,6 +14,8 @@ import type { QuerySuggestionsIndexWithIndexParam } from '../model/querySuggesti import type { Status } from '../model/status'; import type { SucessResponse } from '../model/sucessResponse'; +export const version = '5.0.0'; + export class QuerySuggestionsApi { protected authentications = { apiKey: 'Algolia-API-Key', @@ -62,7 +64,7 @@ export class QuerySuggestionsApi { baseHeaders: { 'content-type': 'application/x-www-form-urlencoded', }, - userAgent: 'Algolia for Javascript', + userAgent: 'Algolia for Javascript 5.0.0', timeouts: { connect: 2, read: 5, diff --git a/clients/algoliasearch-client-javascript/client-search/src/searchApi.ts b/clients/algoliasearch-client-javascript/client-search/src/searchApi.ts index 6fc26cd3e9e..764983147b1 100644 --- a/clients/algoliasearch-client-javascript/client-search/src/searchApi.ts +++ b/clients/algoliasearch-client-javascript/client-search/src/searchApi.ts @@ -63,6 +63,8 @@ import type { UpdatedAtWithObjectIdResponse } from '../model/updatedAtWithObject import type { UpdatedRuleResponse } from '../model/updatedRuleResponse'; import type { UserId } from '../model/userId'; +export const version = '5.0.0'; + export class SearchApi { protected authentications = { apiKey: 'Algolia-API-Key', @@ -110,7 +112,7 @@ export class SearchApi { baseHeaders: { 'content-type': 'application/x-www-form-urlencoded', }, - userAgent: 'Algolia for Javascript', + userAgent: 'Algolia for Javascript 5.0.0', timeouts: { connect: 2, read: 5, diff --git a/clients/algoliasearch-client-javascript/client-sources/src/sourcesApi.ts b/clients/algoliasearch-client-javascript/client-sources/src/sourcesApi.ts index d25c02f6238..5653eb45482 100644 --- a/clients/algoliasearch-client-javascript/client-sources/src/sourcesApi.ts +++ b/clients/algoliasearch-client-javascript/client-sources/src/sourcesApi.ts @@ -10,6 +10,8 @@ import type { import type { PostIngestUrlResponse } from '../model/postIngestUrlResponse'; import type { PostURLJob } from '../model/postURLJob'; +export const version = '0.0.1'; + export class SourcesApi { protected authentications = { apiKey: 'Algolia-API-Key', @@ -58,7 +60,7 @@ export class SourcesApi { baseHeaders: { 'content-type': 'application/x-www-form-urlencoded', }, - userAgent: 'Algolia for Javascript', + userAgent: 'Algolia for Javascript 0.0.1', timeouts: { connect: 2, read: 5, diff --git a/clients/algoliasearch-client-javascript/recommend/src/recommendApi.ts b/clients/algoliasearch-client-javascript/recommend/src/recommendApi.ts index 538d738cf82..87063c00636 100644 --- a/clients/algoliasearch-client-javascript/recommend/src/recommendApi.ts +++ b/clients/algoliasearch-client-javascript/recommend/src/recommendApi.ts @@ -10,6 +10,8 @@ import type { import type { GetRecommendations } from '../model/getRecommendations'; import type { GetRecommendationsResponse } from '../model/getRecommendationsResponse'; +export const version = '5.0.0'; + export class RecommendApi { protected authentications = { apiKey: 'Algolia-API-Key', @@ -57,7 +59,7 @@ export class RecommendApi { baseHeaders: { 'content-type': 'application/x-www-form-urlencoded', }, - userAgent: 'Algolia for Javascript', + userAgent: 'Algolia for Javascript 5.0.0', timeouts: { connect: 2, read: 5, diff --git a/openapitools.json b/openapitools.json index eb37cd36216..88ac1ba4d68 100644 --- a/openapitools.json +++ b/openapitools.json @@ -18,7 +18,7 @@ "modelPropertyNaming": "original", "supportsES6": true, "npmName": "@algolia/client-search", - "npmVersion": "5.0.0", + "packageVersion": "5.0.0", "packageName": "@algolia/client-search", "isSearchHost": true @@ -39,7 +39,7 @@ "modelPropertyNaming": "original", "supportsES6": true, "npmName": "@algolia/recommend", - "npmVersion": "5.0.0", + "packageVersion": "5.0.0", "packageName": "@algolia/recommend", "isSearchHost": true @@ -59,7 +59,7 @@ "modelPropertyNaming": "original", "supportsES6": true, "npmName": "@algolia/client-personalization", - "npmVersion": "5.0.0", + "packageVersion": "5.0.0", "packageName": "@algolia/client-personalization", "hasRegionalHost": true, @@ -81,7 +81,7 @@ "modelPropertyNaming": "original", "supportsES6": true, "npmName": "@algolia/client-analytics", - "npmVersion": "5.0.0", + "packageVersion": "5.0.0", "packageName": "@algolia/client-analytics", "hasRegionalHost": true, @@ -103,7 +103,7 @@ "modelPropertyNaming": "original", "supportsES6": true, "npmName": "@algolia/client-insights", - "npmVersion": "5.0.0", + "packageVersion": "5.0.0", "packageName": "@algolia/client-insights", "host": "insights" @@ -123,7 +123,7 @@ "modelPropertyNaming": "original", "supportsES6": true, "npmName": "@algolia/client-abtesting", - "npmVersion": "5.0.0", + "packageVersion": "5.0.0", "packageName": "@algolia/client-abtesting", "hasRegionalHost": true, @@ -145,7 +145,7 @@ "modelPropertyNaming": "original", "supportsES6": true, "npmName": "@algolia/client-query-suggestions", - "npmVersion": "5.0.0", + "packageVersion": "5.0.0", "packageName": "@algolia/client-query-suggestions", "hasRegionalHost": true, @@ -167,7 +167,7 @@ "modelPropertyNaming": "original", "supportsES6": true, "npmName": "@algolia/client-sources", - "npmVersion": "0.0.1", + "packageVersion": "0.0.1", "packageName": "@algolia/client-sources", "hasRegionalHost": true, diff --git a/templates/javascript/api-single.mustache b/templates/javascript/api-single.mustache index c3dd04237df..8825e8f27f7 100644 --- a/templates/javascript/api-single.mustache +++ b/templates/javascript/api-single.mustache @@ -5,6 +5,8 @@ import type { Headers, Requester, Host, Request, RequestOptions } from '@algolia import { {{classname}} } from '{{filename}}'; {{/imports}} +export const version = '{{packageVersion}}'; + {{#operations}} {{#description}} /** @@ -65,7 +67,7 @@ export class {{classname}} { baseHeaders: { 'content-type': 'application/x-www-form-urlencoded' }, - userAgent: 'Algolia for Javascript', + userAgent: 'Algolia for Javascript {{packageVersion}}', timeouts: { connect: 2, read: 5, diff --git a/templates/javascript/package.mustache b/templates/javascript/package.mustache index a61bf5d26ec..3ddc7606d43 100644 --- a/templates/javascript/package.mustache +++ b/templates/javascript/package.mustache @@ -1,6 +1,6 @@ { "name": "{{packageName}}", - "version": "{{npmVersion}}", + "version": "{{packageVersion}}", "description": "JavaScript client for {{packageName}}", "repository": "{{gitUserId}}/{{gitRepoId}}", "author": "Algolia", From e9dadc7716eacef854f7040d500e29c74ee5f579 Mon Sep 17 00:00:00 2001 From: Eunjae Lee Date: Wed, 26 Jan 2022 11:15:35 +0100 Subject: [PATCH 2/2] fix: user agent format --- .../client-abtesting/src/abtestingApi.ts | 2 +- .../client-analytics/src/analyticsApi.ts | 2 +- .../client-insights/src/insightsApi.ts | 2 +- .../client-personalization/src/personalizationApi.ts | 2 +- .../client-query-suggestions/src/querySuggestionsApi.ts | 2 +- .../client-search/src/searchApi.ts | 2 +- .../client-sources/src/sourcesApi.ts | 2 +- .../recommend/src/recommendApi.ts | 2 +- templates/javascript/api-single.mustache | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/clients/algoliasearch-client-javascript/client-abtesting/src/abtestingApi.ts b/clients/algoliasearch-client-javascript/client-abtesting/src/abtestingApi.ts index df53a2ef02b..bbdb91880bf 100644 --- a/clients/algoliasearch-client-javascript/client-abtesting/src/abtestingApi.ts +++ b/clients/algoliasearch-client-javascript/client-abtesting/src/abtestingApi.ts @@ -62,7 +62,7 @@ export class AbtestingApi { baseHeaders: { 'content-type': 'application/x-www-form-urlencoded', }, - userAgent: 'Algolia for Javascript 5.0.0', + userAgent: 'Algolia for Javascript (5.0.0)', timeouts: { connect: 2, read: 5, diff --git a/clients/algoliasearch-client-javascript/client-analytics/src/analyticsApi.ts b/clients/algoliasearch-client-javascript/client-analytics/src/analyticsApi.ts index ff24ed30fac..4ad0aab5908 100644 --- a/clients/algoliasearch-client-javascript/client-analytics/src/analyticsApi.ts +++ b/clients/algoliasearch-client-javascript/client-analytics/src/analyticsApi.ts @@ -77,7 +77,7 @@ export class AnalyticsApi { baseHeaders: { 'content-type': 'application/x-www-form-urlencoded', }, - userAgent: 'Algolia for Javascript 5.0.0', + userAgent: 'Algolia for Javascript (5.0.0)', timeouts: { connect: 2, read: 5, diff --git a/clients/algoliasearch-client-javascript/client-insights/src/insightsApi.ts b/clients/algoliasearch-client-javascript/client-insights/src/insightsApi.ts index 100f3fedbb3..f5b7cf299fc 100644 --- a/clients/algoliasearch-client-javascript/client-insights/src/insightsApi.ts +++ b/clients/algoliasearch-client-javascript/client-insights/src/insightsApi.ts @@ -59,7 +59,7 @@ export class InsightsApi { baseHeaders: { 'content-type': 'application/x-www-form-urlencoded', }, - userAgent: 'Algolia for Javascript 5.0.0', + userAgent: 'Algolia for Javascript (5.0.0)', timeouts: { connect: 2, read: 5, diff --git a/clients/algoliasearch-client-javascript/client-personalization/src/personalizationApi.ts b/clients/algoliasearch-client-javascript/client-personalization/src/personalizationApi.ts index 3088333fab6..251fde7b437 100644 --- a/clients/algoliasearch-client-javascript/client-personalization/src/personalizationApi.ts +++ b/clients/algoliasearch-client-javascript/client-personalization/src/personalizationApi.ts @@ -62,7 +62,7 @@ export class PersonalizationApi { baseHeaders: { 'content-type': 'application/x-www-form-urlencoded', }, - userAgent: 'Algolia for Javascript 5.0.0', + userAgent: 'Algolia for Javascript (5.0.0)', timeouts: { connect: 2, read: 5, diff --git a/clients/algoliasearch-client-javascript/client-query-suggestions/src/querySuggestionsApi.ts b/clients/algoliasearch-client-javascript/client-query-suggestions/src/querySuggestionsApi.ts index bd75192dd72..9eba63df348 100644 --- a/clients/algoliasearch-client-javascript/client-query-suggestions/src/querySuggestionsApi.ts +++ b/clients/algoliasearch-client-javascript/client-query-suggestions/src/querySuggestionsApi.ts @@ -64,7 +64,7 @@ export class QuerySuggestionsApi { baseHeaders: { 'content-type': 'application/x-www-form-urlencoded', }, - userAgent: 'Algolia for Javascript 5.0.0', + userAgent: 'Algolia for Javascript (5.0.0)', timeouts: { connect: 2, read: 5, diff --git a/clients/algoliasearch-client-javascript/client-search/src/searchApi.ts b/clients/algoliasearch-client-javascript/client-search/src/searchApi.ts index 764983147b1..5d0763029b8 100644 --- a/clients/algoliasearch-client-javascript/client-search/src/searchApi.ts +++ b/clients/algoliasearch-client-javascript/client-search/src/searchApi.ts @@ -112,7 +112,7 @@ export class SearchApi { baseHeaders: { 'content-type': 'application/x-www-form-urlencoded', }, - userAgent: 'Algolia for Javascript 5.0.0', + userAgent: 'Algolia for Javascript (5.0.0)', timeouts: { connect: 2, read: 5, diff --git a/clients/algoliasearch-client-javascript/client-sources/src/sourcesApi.ts b/clients/algoliasearch-client-javascript/client-sources/src/sourcesApi.ts index 5653eb45482..04f5d15f345 100644 --- a/clients/algoliasearch-client-javascript/client-sources/src/sourcesApi.ts +++ b/clients/algoliasearch-client-javascript/client-sources/src/sourcesApi.ts @@ -60,7 +60,7 @@ export class SourcesApi { baseHeaders: { 'content-type': 'application/x-www-form-urlencoded', }, - userAgent: 'Algolia for Javascript 0.0.1', + userAgent: 'Algolia for Javascript (0.0.1)', timeouts: { connect: 2, read: 5, diff --git a/clients/algoliasearch-client-javascript/recommend/src/recommendApi.ts b/clients/algoliasearch-client-javascript/recommend/src/recommendApi.ts index 87063c00636..4be4156be22 100644 --- a/clients/algoliasearch-client-javascript/recommend/src/recommendApi.ts +++ b/clients/algoliasearch-client-javascript/recommend/src/recommendApi.ts @@ -59,7 +59,7 @@ export class RecommendApi { baseHeaders: { 'content-type': 'application/x-www-form-urlencoded', }, - userAgent: 'Algolia for Javascript 5.0.0', + userAgent: 'Algolia for Javascript (5.0.0)', timeouts: { connect: 2, read: 5, diff --git a/templates/javascript/api-single.mustache b/templates/javascript/api-single.mustache index 8825e8f27f7..0009e2a1a2b 100644 --- a/templates/javascript/api-single.mustache +++ b/templates/javascript/api-single.mustache @@ -67,7 +67,7 @@ export class {{classname}} { baseHeaders: { 'content-type': 'application/x-www-form-urlencoded' }, - userAgent: 'Algolia for Javascript {{packageVersion}}', + userAgent: 'Algolia for Javascript ({{packageVersion}})', timeouts: { connect: 2, read: 5,