-
Notifications
You must be signed in to change notification settings - Fork 26
docs: integration requests #700
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.
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
Closed
Closed
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
Define integration requests for your deployed content by defining `integration_requests` in your content's `manifest.json` file, which can be produced manually or using the [`write-manifest`](../commands/write-manifest.md) command. | ||
|
||
### Integration Request Specification | ||
|
||
During deployment, these integration requests will be processed, and the specified integration specifications will be matched to integrations that are available on the Connect server. If a matching integration is found, it will be used for the deployment. If no matching integration is found, the deployment will fail with an error message indicating that the integration request could not be satisfied. | ||
|
||
| Field | Description | Matching Type | Example | | ||
|-------|-------------|---------------|---------| | ||
| `name` | String identifier for the integration | regex match | `"my-integration"` | | ||
| `description` | Description of the integration | regex match | `"My Azure Integration"` | | ||
| `type` | Integration type | exact match | `"azure"` | | ||
| `guid` | Unique identifier for the integration | exact match | `"123e4567-e89b-12d3-a456-426614174000"` | | ||
| `auth_type` | Authentication type | exact match | `"Viewer"` | | ||
| `config` | Configuration settings for the integration | key-value match | `"{"auth_mode": "Confidential"}"` | | ||
|
||
Possible values for `type` include: | ||
- `azure` | ||
- `azure-openai` | ||
- `sharepoint` | ||
- `msgraph` | ||
- `bigquery` | ||
- `drive` | ||
- `sheets` | ||
- `vertex-ai` | ||
- `databricks` | ||
- `github` | ||
- `salesforce` | ||
- `snowflake` | ||
- `connect` | ||
- `aws` | ||
- `custom` | ||
|
||
Possible values for `auth_type` include: | ||
- `Viewer` | ||
- `Service Account` | ||
- `Visitor API Key` | ||
joshyam-k marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
|
||
### Example | ||
|
||
```json | ||
{ | ||
// ... | ||
"integration_requests": [ | ||
{"name": "my-integration", "type": "azure"}, | ||
{"name": "another-integration", "type": "aws"}, | ||
{"name": "custom-integration", "type": "custom", "config": {"auth_mode": "Confidential"}}, | ||
{"guid": "123e4567-e89b-12d3-a456-426614174000"} | ||
] | ||
// ... | ||
} | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.