Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(specs): add algoliaInsights auth type #2959

Merged
merged 2 commits into from
Apr 5, 2024
Merged

feat(specs): add algoliaInsights auth type #2959

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
124b1f4
feat(specs): add algoliaInsights auth type
jkaho Apr 5, 2024
15f5d5b
Merge branch 'main' into EEX-1038/add-algolia-insights-auth-type
jkaho Apr 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion specs/ingestion/common/schemas/authentication.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ AuthenticationSearch:
AuthenticationType:
type: string
description: Type of authentication. This determines the type of credentials required in the `input` object.
enum: [googleServiceAccount, basic, apiKey, oauth, algolia]
enum: [googleServiceAccount, basic, apiKey, oauth, algolia, algoliaInsights]

Platform:
default: null
Expand Down Expand Up @@ -187,6 +187,21 @@ AuthAlgoliaPartial:
Algolia API key with the ACL: `addObject`, `deleteObject`, `settings`, `editSettings`, `listIndexes`, `deleteIndex`.
This field is `null` in the API response.

AuthAlgoliaInsightsPartial:
title: Algolia Insights
type: object
additionalProperties: false
description: Credentials for authenticating with the Algolia Insights API.
properties:
appID:
type: string
description: Algolia application ID.
apiKey:
type: string
description: |
Algolia API key with the ACL: `search`.
This field is `null` in the API response.

AuthGoogleServiceAccount:
title: Google service account
type: object
Expand Down Expand Up @@ -274,13 +289,32 @@ AuthAlgolia:
- appID
- apiKey

AuthAlgoliaInsights:
title: Algolia Insights
type: object
additionalProperties: false
description: Credentials for authenticating with the Algolia Insights API.
properties:
appID:
type: string
description: Algolia application ID.
apiKey:
type: string
description: |
Algolia API key with the ACL: `search`.
This field is `null` in the API response.
required:
- appID
- apiKey

AuthInput:
oneOf:
- $ref: '#/AuthGoogleServiceAccount'
- $ref: '#/AuthBasic'
- $ref: '#/AuthAPIKey'
- $ref: '#/AuthOAuth'
- $ref: '#/AuthAlgolia'
- $ref: '#/AuthAlgoliaInsights'

AuthInputPartial:
oneOf:
Expand All @@ -289,3 +323,4 @@ AuthInputPartial:
- $ref: '#/AuthAPIKeyPartial'
- $ref: '#/AuthOAuthPartial'
- $ref: '#/AuthAlgoliaPartial'
- $ref: '#/AuthAlgoliaInsightsPartial'
Loading