-
Notifications
You must be signed in to change notification settings - Fork 3
Fix GET /data_connectors/{id}: correct schema to use present_detail fields #407
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
f5f7ff9
Fix GET /data_connectors/{id} schema: use present_detail fields + add…
salmanbshah 7fcccf9
Address review: remove state_version param (not GA), consolidate chan…
salmanbshah 17117c7
Drop changelog.md changes per review
salmanbshah 174069d
Add enum constraints to data_connector_detail schema fields
salmanbshah 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
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 | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -10240,7 +10240,7 @@ paths: | |||||||||||||||||||||||
| "$ref": "#/components/schemas/intercom_version" | ||||||||||||||||||||||||
| - name: id | ||||||||||||||||||||||||
| in: path | ||||||||||||||||||||||||
| description: The unique identifier of the data connector | ||||||||||||||||||||||||
| description: The unique identifier of the data connector. | ||||||||||||||||||||||||
| example: '12345' | ||||||||||||||||||||||||
| required: true | ||||||||||||||||||||||||
| schema: | ||||||||||||||||||||||||
|
|
@@ -10249,9 +10249,9 @@ paths: | |||||||||||||||||||||||
| - Data Connectors | ||||||||||||||||||||||||
| operationId: RetrieveDataConnector | ||||||||||||||||||||||||
| description: | | ||||||||||||||||||||||||
| You can retrieve a single data connector by its ID. | ||||||||||||||||||||||||
| You can retrieve the full detail of a single data connector by its ID. | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| The response includes full detail about the connector including its configuration, data inputs, response fields, and object mappings. | ||||||||||||||||||||||||
| The response includes configuration, data inputs, response fields, and object mappings. | ||||||||||||||||||||||||
| responses: | ||||||||||||||||||||||||
| '200': | ||||||||||||||||||||||||
| description: Data connector found | ||||||||||||||||||||||||
|
|
@@ -10267,11 +10267,37 @@ paths: | |||||||||||||||||||||||
| state: live | ||||||||||||||||||||||||
| http_method: post | ||||||||||||||||||||||||
| direct_fin_usage: false | ||||||||||||||||||||||||
| audiences: | ||||||||||||||||||||||||
| - user | ||||||||||||||||||||||||
| - lead | ||||||||||||||||||||||||
| execution_type: server_side | ||||||||||||||||||||||||
| configuration_response_type: json | ||||||||||||||||||||||||
| data_transformation_type: | ||||||||||||||||||||||||
| client_function_name: | ||||||||||||||||||||||||
| client_function_timeout_ms: | ||||||||||||||||||||||||
| data_inputs: | ||||||||||||||||||||||||
| - name: conversation_id | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| description: The Intercom conversation ID | ||||||||||||||||||||||||
| required: true | ||||||||||||||||||||||||
| source: conversation | ||||||||||||||||||||||||
| response_fields: | ||||||||||||||||||||||||
| - path: status | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| example_value: ok | ||||||||||||||||||||||||
| redacted: false | ||||||||||||||||||||||||
| object_mappings: [] | ||||||||||||||||||||||||
| token_ids: [] | ||||||||||||||||||||||||
| customer_authentication: false | ||||||||||||||||||||||||
| bypass_authentication: false | ||||||||||||||||||||||||
| validate_missing_attributes: | ||||||||||||||||||||||||
| created_by_admin_id: '456' | ||||||||||||||||||||||||
| updated_by_admin_id: '456' | ||||||||||||||||||||||||
| created_at: '2025-11-15T09:30:00Z' | ||||||||||||||||||||||||
| updated_at: '2026-01-20T14:22:15Z' | ||||||||||||||||||||||||
| execution_results_url: "/data_connectors/12345/execution_results" | ||||||||||||||||||||||||
| schema: | ||||||||||||||||||||||||
| "$ref": "#/components/schemas/data_connector" | ||||||||||||||||||||||||
| "$ref": "#/components/schemas/data_connector_detail" | ||||||||||||||||||||||||
| '404': | ||||||||||||||||||||||||
| description: Data connector not found | ||||||||||||||||||||||||
| content: | ||||||||||||||||||||||||
|
|
@@ -21724,6 +21750,209 @@ components: | |||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| description: The URL path to fetch execution results for this connector. | ||||||||||||||||||||||||
| example: "/data_connectors/12345/execution_results" | ||||||||||||||||||||||||
| data_connector_detail: | ||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Missing enums on These 9 fields are backed by Rails enums or frozen constant arrays but are documented as freeform
|
||||||||||||||||||||||||
| title: Data Connector (Detail) | ||||||||||||||||||||||||
| type: object | ||||||||||||||||||||||||
| x-tags: | ||||||||||||||||||||||||
| - Data Connectors | ||||||||||||||||||||||||
| description: | | ||||||||||||||||||||||||
| Full detail view of a data connector, returned by `GET /data_connectors/{id}`. | ||||||||||||||||||||||||
| Includes configuration, data inputs, response fields, and object mappings. | ||||||||||||||||||||||||
| properties: | ||||||||||||||||||||||||
| type: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| description: The type of object - `data_connector`. | ||||||||||||||||||||||||
| enum: | ||||||||||||||||||||||||
| - data_connector | ||||||||||||||||||||||||
| example: data_connector | ||||||||||||||||||||||||
| id: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| description: The unique identifier for the data connector. | ||||||||||||||||||||||||
| example: '12345' | ||||||||||||||||||||||||
| name: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| description: The name of the data connector. | ||||||||||||||||||||||||
| example: Slack Notification Service | ||||||||||||||||||||||||
| description: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| nullable: true | ||||||||||||||||||||||||
| description: A description of what this data connector does. | ||||||||||||||||||||||||
| example: Posts conversation updates to Slack channel | ||||||||||||||||||||||||
| state: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| description: The current state of the data connector. | ||||||||||||||||||||||||
| enum: | ||||||||||||||||||||||||
| - draft | ||||||||||||||||||||||||
| - live | ||||||||||||||||||||||||
| example: live | ||||||||||||||||||||||||
| http_method: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| description: The HTTP method used by the data connector. | ||||||||||||||||||||||||
| enum: | ||||||||||||||||||||||||
| - get | ||||||||||||||||||||||||
| - post | ||||||||||||||||||||||||
| - put | ||||||||||||||||||||||||
| - delete | ||||||||||||||||||||||||
| - patch | ||||||||||||||||||||||||
| example: post | ||||||||||||||||||||||||
| direct_fin_usage: | ||||||||||||||||||||||||
| type: boolean | ||||||||||||||||||||||||
| description: Whether this connector is used directly by Fin. | ||||||||||||||||||||||||
| example: false | ||||||||||||||||||||||||
| audiences: | ||||||||||||||||||||||||
| type: array | ||||||||||||||||||||||||
| description: The audience types this connector targets. | ||||||||||||||||||||||||
| items: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| example: | ||||||||||||||||||||||||
| - user | ||||||||||||||||||||||||
| - lead | ||||||||||||||||||||||||
| execution_type: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| nullable: true | ||||||||||||||||||||||||
| description: How the connector executes (e.g. `server_side`, `client_side`). | ||||||||||||||||||||||||
| example: server_side | ||||||||||||||||||||||||
| configuration_response_type: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| nullable: true | ||||||||||||||||||||||||
| description: The expected response format from the connector. | ||||||||||||||||||||||||
| example: json | ||||||||||||||||||||||||
| data_transformation_type: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| nullable: true | ||||||||||||||||||||||||
| description: The type of data transformation applied to the response. | ||||||||||||||||||||||||
| client_function_name: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| nullable: true | ||||||||||||||||||||||||
| description: The name of the client-side function, if applicable. | ||||||||||||||||||||||||
| client_function_timeout_ms: | ||||||||||||||||||||||||
| type: integer | ||||||||||||||||||||||||
| nullable: true | ||||||||||||||||||||||||
| description: Timeout in milliseconds for the client function, if applicable. | ||||||||||||||||||||||||
| data_inputs: | ||||||||||||||||||||||||
| type: array | ||||||||||||||||||||||||
| description: The input parameters accepted by this data connector. | ||||||||||||||||||||||||
| items: | ||||||||||||||||||||||||
| type: object | ||||||||||||||||||||||||
| properties: | ||||||||||||||||||||||||
| name: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| description: The name of the input parameter. | ||||||||||||||||||||||||
| example: conversation_id | ||||||||||||||||||||||||
| type: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| description: The data type of the input. | ||||||||||||||||||||||||
| example: string | ||||||||||||||||||||||||
| description: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| nullable: true | ||||||||||||||||||||||||
| description: A description of the input parameter. | ||||||||||||||||||||||||
| required: | ||||||||||||||||||||||||
| type: boolean | ||||||||||||||||||||||||
| description: Whether this input is required. | ||||||||||||||||||||||||
| example: true | ||||||||||||||||||||||||
| default_value: | ||||||||||||||||||||||||
| nullable: true | ||||||||||||||||||||||||
| description: The default value for this input, if any. | ||||||||||||||||||||||||
| source: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| nullable: true | ||||||||||||||||||||||||
| description: The source context for this input (e.g. `contact`, `conversation`). | ||||||||||||||||||||||||
| example: conversation | ||||||||||||||||||||||||
| response_fields: | ||||||||||||||||||||||||
| type: array | ||||||||||||||||||||||||
| description: The fields returned in the connector response. | ||||||||||||||||||||||||
| items: | ||||||||||||||||||||||||
| type: object | ||||||||||||||||||||||||
| properties: | ||||||||||||||||||||||||
| path: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| description: The JSON path of the response field. | ||||||||||||||||||||||||
| example: status | ||||||||||||||||||||||||
| type: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| description: The data type of the response field. | ||||||||||||||||||||||||
| example: string | ||||||||||||||||||||||||
| example_value: | ||||||||||||||||||||||||
| nullable: true | ||||||||||||||||||||||||
| description: An example value for this field. | ||||||||||||||||||||||||
| example: ok | ||||||||||||||||||||||||
| redacted: | ||||||||||||||||||||||||
| type: boolean | ||||||||||||||||||||||||
| description: Whether this field is redacted in logs. | ||||||||||||||||||||||||
| example: false | ||||||||||||||||||||||||
| object_mappings: | ||||||||||||||||||||||||
| type: array | ||||||||||||||||||||||||
| description: Mappings from connector response objects to Intercom objects. | ||||||||||||||||||||||||
| items: | ||||||||||||||||||||||||
| type: object | ||||||||||||||||||||||||
| properties: | ||||||||||||||||||||||||
| response_object_path: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| intercom_object_type: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| attribute_mappings: | ||||||||||||||||||||||||
| type: array | ||||||||||||||||||||||||
| items: | ||||||||||||||||||||||||
| type: object | ||||||||||||||||||||||||
| properties: | ||||||||||||||||||||||||
| response_attribute_path: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| intercom_attribute_identifier: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| mapping_type: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| reference_mappings: | ||||||||||||||||||||||||
| type: array | ||||||||||||||||||||||||
| items: | ||||||||||||||||||||||||
| type: object | ||||||||||||||||||||||||
| properties: | ||||||||||||||||||||||||
| intercom_object_type: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| intercom_attribute_identifier: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| token_ids: | ||||||||||||||||||||||||
| type: array | ||||||||||||||||||||||||
| description: IDs of authentication tokens associated with this connector. | ||||||||||||||||||||||||
| items: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| example: [] | ||||||||||||||||||||||||
| customer_authentication: | ||||||||||||||||||||||||
| type: boolean | ||||||||||||||||||||||||
| description: Whether OTP authentication is enabled for this connector. | ||||||||||||||||||||||||
| example: false | ||||||||||||||||||||||||
| bypass_authentication: | ||||||||||||||||||||||||
| type: boolean | ||||||||||||||||||||||||
| description: Whether authentication is bypassed for this connector. | ||||||||||||||||||||||||
| example: false | ||||||||||||||||||||||||
| validate_missing_attributes: | ||||||||||||||||||||||||
| type: boolean | ||||||||||||||||||||||||
| nullable: true | ||||||||||||||||||||||||
| description: Whether to validate missing attributes before execution. | ||||||||||||||||||||||||
| created_by_admin_id: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| nullable: true | ||||||||||||||||||||||||
| description: The ID of the admin who created this connector. | ||||||||||||||||||||||||
| example: '456' | ||||||||||||||||||||||||
| updated_by_admin_id: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| nullable: true | ||||||||||||||||||||||||
| description: The ID of the admin who last updated this connector. | ||||||||||||||||||||||||
| example: '456' | ||||||||||||||||||||||||
| created_at: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| format: date-time | ||||||||||||||||||||||||
| description: The time the data connector was created. | ||||||||||||||||||||||||
| example: '2025-11-15T09:30:00Z' | ||||||||||||||||||||||||
| updated_at: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| format: date-time | ||||||||||||||||||||||||
| description: The time the data connector was last updated. | ||||||||||||||||||||||||
| example: '2026-01-20T14:22:15Z' | ||||||||||||||||||||||||
| execution_results_url: | ||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||
| description: The URL path to fetch execution results for this connector. | ||||||||||||||||||||||||
| example: "/data_connectors/12345/execution_results" | ||||||||||||||||||||||||
| data_connector_execution_result: | ||||||||||||||||||||||||
| title: Data Connector Execution Result | ||||||||||||||||||||||||
| type: object | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
source: conversationis not a valid value. It's restricted tofin,custom,attribute. Fin is the common example