Skip to content

Commit 0348669

Browse files
authored
feat(specs): add algoliaInsights auth type (#2959)
1 parent e8299b8 commit 0348669

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

specs/ingestion/common/schemas/authentication.yml

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ AuthenticationSearch:
103103
AuthenticationType:
104104
type: string
105105
description: Type of authentication. This determines the type of credentials required in the `input` object.
106-
enum: [googleServiceAccount, basic, apiKey, oauth, algolia]
106+
enum: [googleServiceAccount, basic, apiKey, oauth, algolia, algoliaInsights]
107107

108108
Platform:
109109
default: null
@@ -187,6 +187,21 @@ AuthAlgoliaPartial:
187187
Algolia API key with the ACL: `addObject`, `deleteObject`, `settings`, `editSettings`, `listIndexes`, `deleteIndex`.
188188
This field is `null` in the API response.
189189
190+
AuthAlgoliaInsightsPartial:
191+
title: Algolia Insights
192+
type: object
193+
additionalProperties: false
194+
description: Credentials for authenticating with the Algolia Insights API.
195+
properties:
196+
appID:
197+
type: string
198+
description: Algolia application ID.
199+
apiKey:
200+
type: string
201+
description: |
202+
Algolia API key with the ACL: `search`.
203+
This field is `null` in the API response.
204+
190205
AuthGoogleServiceAccount:
191206
title: Google service account
192207
type: object
@@ -274,13 +289,32 @@ AuthAlgolia:
274289
- appID
275290
- apiKey
276291

292+
AuthAlgoliaInsights:
293+
title: Algolia Insights
294+
type: object
295+
additionalProperties: false
296+
description: Credentials for authenticating with the Algolia Insights API.
297+
properties:
298+
appID:
299+
type: string
300+
description: Algolia application ID.
301+
apiKey:
302+
type: string
303+
description: |
304+
Algolia API key with the ACL: `search`.
305+
This field is `null` in the API response.
306+
required:
307+
- appID
308+
- apiKey
309+
277310
AuthInput:
278311
oneOf:
279312
- $ref: '#/AuthGoogleServiceAccount'
280313
- $ref: '#/AuthBasic'
281314
- $ref: '#/AuthAPIKey'
282315
- $ref: '#/AuthOAuth'
283316
- $ref: '#/AuthAlgolia'
317+
- $ref: '#/AuthAlgoliaInsights'
284318

285319
AuthInputPartial:
286320
oneOf:
@@ -289,3 +323,4 @@ AuthInputPartial:
289323
- $ref: '#/AuthAPIKeyPartial'
290324
- $ref: '#/AuthOAuthPartial'
291325
- $ref: '#/AuthAlgoliaPartial'
326+
- $ref: '#/AuthAlgoliaInsightsPartial'

0 commit comments

Comments
 (0)