Skip to content

docs(source-gong): update OAuth scopes in prerequisites and fix changelog date#75547

Merged
octavia-bot-hoard[bot] merged 1 commit intomasterfrom
devin/1774648958-source-gong-docs-update
Mar 27, 2026
Merged

docs(source-gong): update OAuth scopes in prerequisites and fix changelog date#75547
octavia-bot-hoard[bot] merged 1 commit intomasterfrom
devin/1774648958-source-gong-docs-update

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration bot commented Mar 27, 2026

Documentation Confidence Assessment

Overall Confidence: 4/5

Dimension Score Rationale
Code Comprehension 5/5 Manifest-only YAML; all streams, auth, pagination, and scopes are fully declarative with no custom code.
API Documentation Quality 3/5 Official Gong docs cover auth flow and rate limits, but OAuth scope requirements are scattered across multiple sources.
Change Scope & Risk 5/5 Under 5 lines changed: corrected scopes list, added API key scope note, fixed changelog date.
Existing Doc Maturity 3/5 ~146-line doc with good structure covering prerequisites, setup, streams, and performance considerations.
Connector Sensitivity 5/5 Community connector with low usage (ql=100, sl=100).
Triggering Context 5/5 Triggered from a small, merged PR (#75195) that migrated OAuth scopes to an object array.

What I Verified vs. What I Inferred

  • Verified from code: The manifest's scopes array now contains 7 scopes: api:calls:read:basic, api:calls:read:extensive, api:calls:read:transcript, api:users:read, api:stats:scorecards, api:stats:interaction, api:settings:scorecards:read. The previous docs listed only 5 (missing api:calls:read:transcript and api:settings:scorecards:read).
  • Verified from API docs: Gong's OAuth flow requires scopes to be declared during the consent URL. The api:calls:read:transcript scope is required for the /v2/calls/transcript endpoint (confirmed via Gong API reference and community sources). Rate limits are 3 calls/second and 10,000 calls/day.
  • Verified from PR metadata: PR feat(source-gong): migrate OAuth scope to scopes object array #75195 was merged on 2026-03-27 (commit timestamp Fri Mar 27 21:59:31 2026 +0000), but the changelog entry listed 2026-03-26.
  • Inferred: That API Key authentication also requires the same scopes to be granted in Gong's API settings. This is consistent with how Gong's API works (scopes are enforced server-side regardless of auth method), but was not directly confirmed from a single authoritative source.

Areas of Concern

  • The API Key scope requirement note is based on inference from how Gong's API enforces scopes. A reviewer familiar with Gong's API key provisioning flow should verify this is accurate guidance.

What

Updates the source-gong documentation to reflect changes introduced in #75195 (v0.6.3), which migrated OAuth configuration to a scopes object array and added two new API scopes.

How

Three changes to docs/integrations/sources/gong.md:

  1. Prerequisites — OAuth scopes (correction): Added the two new scopes (api:calls:read:transcript, api:settings:scorecards:read) that were added to the connector's manifest in v0.6.3. The docs previously listed only 5 scopes; the connector now requests 7.
  2. Prerequisites — API Key scopes (addition): Added a note that API Key users need the same scopes granted in Gong's API settings.
  3. Changelog date (correction): Fixed the v0.6.3 release date from 2026-03-26 to 2026-03-27 to match the actual merge date of PR feat(source-gong): migrate OAuth scope to scopes object array #75195.

Review Guide

  1. Lines 13--14: Updated OAuth scope list and new API Key scope note in Prerequisites.
  2. Line 81: Corrected changelog date for v0.6.3.

Note: I am an AI assistant (Devin) and have proposed these documentation updates based on a review of the connector source code and third-party API documentation. Reviewers may merge, modify, or close this PR as they see fit.

…elog date

Co-Authored-By: bot_apk <apk@cognition.ai>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link
Copy Markdown
Contributor

👋 Greetings, Airbyte Team Member!

Here are some helpful tips and reminders for your convenience.

💡 Show Tips and Tricks

PR Slash Commands

Airbyte Maintainers (that's you!) can execute the following slash commands on your PR:

  • 🛠️ Quick Fixes
    • /format-fix - Fixes most formatting issues.
    • /bump-version - Bumps connector versions, scraping changelog description from the PR title.
  • ❇️ AI Testing and Review (internal link: AI-SDLC Docs):
    • /ai-prove-fix - Runs prerelease readiness checks, including testing against customer connections.
    • /ai-canary-prerelease - Rolls out prerelease to 5-10 connections for canary testing.
    • /ai-review - AI-powered PR review for connector safety and quality gates.
  • 🚀 Connector Releases:
    • /publish-connectors-prerelease - Publishes pre-release connector builds (tagged as {version}-preview.{git-sha}) for all modified connectors in the PR.
    • /bump-progressive-rollout-version - Bumps connector version with an RC suffix (2.16.10-rc.1) for progressive rollouts (enableProgressiveRollout: true).
      • Example: /bump-progressive-rollout-version changelog="Add new feature for progressive rollout"
  • ☕️ JVM connectors:
    • /update-connector-cdk-version connector=<CONNECTOR_NAME> - Updates the specified connector to the latest CDK version.
      Example: /update-connector-cdk-version connector=destination-bigquery
  • 🐍 Python connectors:
    • /poe connector source-example lock - Run the Poe lock task on the source-example connector, committing the results back to the branch.
    • /poe source example lock - Alias for /poe connector source-example lock.
    • /poe source example use-cdk-branch my/branch - Pin the source-example CDK reference to the branch name specified.
    • /poe source example use-cdk-latest - Update the source-example CDK dependency to the latest available version.
  • ⚙️ Admin commands:
    • /force-merge reason="<REASON>" - Force merges the PR using admin privileges, bypassing CI checks. Requires a reason.
      Example: /force-merge reason="CI is flaky, tests pass locally"
📚 Show Repo Guidance

Helpful Resources

📝 Edit this welcome message.

@devin-ai-integration devin-ai-integration bot added area/documentation Improvements or additions to documentation team/documentation auto-merge labels Mar 27, 2026
@octavia-bot octavia-bot bot marked this pull request as ready for review March 27, 2026 22:06
@github-actions
Copy link
Copy Markdown
Contributor

Deploy preview for airbyte-docs ready!

✅ Preview
https://airbyte-docs-r4ql43gr8-airbyte-growth.vercel.app

Built with commit 9d4ee0f.
This pull request is being automatically deployed with vercel-action

@octavia-bot-hoard octavia-bot-hoard bot merged commit 60ec632 into master Mar 27, 2026
64 checks passed
@octavia-bot-hoard octavia-bot-hoard bot deleted the devin/1774648958-source-gong-docs-update branch March 27, 2026 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Improvements or additions to documentation auto-merge team/documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants