Skip to content

Document GET /data_connectors/{id}#403

Merged
salmanbshah merged 1 commit intomainfrom
salmanshah/docs-data-connectors-show-api
Mar 16, 2026
Merged

Document GET /data_connectors/{id}#403
salmanbshah merged 1 commit intomainfrom
salmanshah/docs-data-connectors-show-api

Conversation

@salmanbshah
Copy link
Contributor

@salmanbshah salmanbshah commented Mar 16, 2026

Why?

Public API endpoints were added to the intercom backend without updating the OpenAPI spec, making them invisible to customers. GET /data_connectors/{id} was implemented in DataConnectorsController but completely absent from all spec versions — customers using the list endpoint had no documented way to retrieve a single connector.

How?

Added GET /data_connectors/{id} to the Unstable spec, reusing the existing data_connector schema already defined for the list response. Unstable-only since GET /data_connectors (the list) is itself Unstable-only.

Decisions

  • Unstable only, no v2.15 backfill: The data_connectors resource doesn't exist in v2.15, so backfilling the show endpoint there would be inconsistent.
  • Reused existing schema: The data_connector object schema was already defined by the list endpoint — no new schema needed.
Implementation Plan

API Documentation Gap Plan

Context

Public API controllers in API::V3 have added features without updating OpenAPI specs. This causes customer pain — developers can't discover or use these endpoints. We'll use agent teams + git worktrees to close 4 gaps (feature-gated controllers skipped until rollout).

Confirmed Gaps (this PR covers gap #1)

# Controller Missing Endpoints Spec Target
1 api/v3/data_connectors_controller.rb GET /data_connectors/{id} Unstable only
2 api/v3/fin_voice_controller.rb GET /fin_voice/conversation/{conversation_id} Unstable + v2.15
3 api/v3/conversation_parts_controller.rb PUT /conversations/{conversation_id}/conversation_parts/{id} Unstable only
4 api/v3/messages_controller.rb GET /messages/whatsapp/status Unstable only

Skipped (feature-flagged, not yet GA)

  • fin/tasks_controller.rbai_answers_billing_feature
  • fin/api_controller.rbfin-agent-api
  • procedures_controller.rbProcedureRuns::Constants::FEATURE_FLAG

Generated with Claude Code

@salmanbshah salmanbshah enabled auto-merge (squash) March 16, 2026 13:27
@salmanbshah salmanbshah force-pushed the salmanshah/docs-data-connectors-show-api branch from 7c43ccb to 4c5a575 Compare March 16, 2026 13:39
@salmanbshah salmanbshah merged commit 5df1b9b into main Mar 16, 2026
3 checks passed
@salmanbshah salmanbshah deleted the salmanshah/docs-data-connectors-show-api branch March 16, 2026 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants