Skip to content

docs(source-google-search-console): fix changelog date, typos, and document missing config options - #75631

Merged
octavia-bot-hoard[bot] merged 1 commit into
masterfrom
devin/1774901579-gsc-docs-update
Mar 30, 2026
Merged

octavia-bot-hoard[bot] merged 1 commit into
masterfrom
devin/1774901579-gsc-docs-update

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Mar 30, 2026 •

Copy link
Copy Markdown
Contributor

Documentation Confidence Assessment

Overall Confidence: 4/5

Dimension Score Rationale
Code Comprehension 4/5 Manifest-only YAML with 3 simple custom components (~184 lines); all streams, auth, and pagination are declarative.
API Documentation Quality 4/5 Official Google docs cover Search Analytics query API, auth scopes, and rate limits well; minor gaps in data type edge cases.
Change Scope & Risk 5/5 Small targeted fixes: changelog date correction, typo fixes, 2 config option additions; 11 insertions, 9 deletions.
Existing Doc Maturity 4/5 Mature 358-line doc with comprehensive coverage of prerequisites, setup, streams, custom reports, and troubleshooting.
Connector Sensitivity 2/5 Certified connector with high usage (ql=400, sl=300); errors here affect many users.
Triggering Context 5/5 Triggered from a small merged bug-fix PR (#75426, v1.10.27).

What I Verified vs. What I Inferred

  • Verified from code: The num_workers config option (order 7, default 40, range 2–100) and always_use_aggregation_type_auto config option (order 8, default false) exist in manifest.yaml and are user-facing but were not documented in the setup steps. The changelog entry for v1.10.27 references PR fix(source-google-search-console): guard numeric fields against complex types (AI-Triage PR) #75426, which was merged on 2026-03-30 (not 2026-03-24). The service account JSON key format uses service_account with an underscore.
  • Verified from API docs: Google Search Console API rate limits (1,200 QPM per site/user), data retention of 16 months, Search Analytics query dimensions and metrics.
  • Inferred: The replacement data retention link (support.google.com/webmasters/answer/7576553) covers the 16-month retention claim — the original third-party blog link explicitly discussed this topic, while the Google link is the closest official equivalent.

Areas of Concern

  • The data retention link replacement should be verified by a reviewer — the original link was a third-party blog (seotesting.com) that specifically discussed 16-month retention; the replacement is Google's official data freshness page, which is a better source but may not explicitly state the 16-month figure.

What

Documentation improvements for the Google Search Console source connector, triggered by the merge of #75426 (v1.10.27). Fixes factual inaccuracies and fills documentation gaps for two undocumented user-facing configuration options.

How

Correctness fixes:

Completeness fixes:

  • Document Number of Concurrent Workers config option (exists in connector spec at order 7, was not mentioned in setup steps)
  • Document Always Use Aggregation Type Auto config option (exists in connector spec at order 8, was not mentioned in setup steps)

Readability/style fixes:

  • Fix grammar: "by it's Name" → "using its Name"
  • Replace escaped parentheses with em dash for the Full Analytics report stream note
  • Replace generic developers.google.com link with specific Google Search Console about page
  • Replace third-party blog link for data retention with Google's official support page

Review guide

  1. docs/integrations/sources/google-search-console.md — single file changed

Items worth verifying:

  • The replacement data retention link (support.google.com/webmasters/answer/7576553) actually covers the 16-month retention claim. The original link was a third-party blog that explicitly discussed this; the new link is Google's official page on data freshness/availability.
  • The new config option descriptions for Number of Concurrent Workers and Always Use Aggregation Type Auto accurately reflect their behavior. Descriptions are derived from the connector's manifest.yaml spec.
  • The Website URL Property description now says "You can add multiple site URLs" — verify this matches the UI experience (the spec defines site_urls as an array).

User Impact

Users reading the Google Search Console connector docs will see corrected information and will now find documentation for two previously undocumented configuration options visible in the Airbyte UI.

Can this PR be safely reverted and rolled back?

  • YES 💚

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.

Link to Devin session: https://app.devin.ai/sessions/fc5a3b3b5d464303a7445858da1fe3b1

…cument missing config options

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.

10. (Optional) For **Data Freshness**, you may choose whether to include "fresh" data that has not been finalized by Google, and may be subject to change. Please note that if you are using Incremental sync mode, we highly recommend leaving this option to its default value of `final`. Refer to the [Data Freshness](#data-freshness) section below for more information on this parameter.
11. (Optional) For **Search Analytics API Requests Per Minute**, you may configure the maximum number of requests per minute for Search Analytics API calls. The default value (1200) matches Google's documented maximum quota. If you are experiencing rate limit errors, you may need to lower this value. Most new Google Cloud projects start with a quota of 60 requests per minute. Check your Google Cloud Console quotas to see your actual limit. Refer to the [Rate Limiting](#rate-limiting) section below for more information.
12. Click **Set up source** and wait for the tests to complete.
11. (Optional) For **Number of Concurrent Workers**, you may configure the number of worker threads used during sync. The default is 40. If you are syncing a large number of site URLs or experiencing rate limit errors, you may want to reduce this value.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 4; Actual: 11; Style: 1/2/3]

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The MD029/ol-prefix warnings on lines 11–14 are pre-existing. The numbered list intentionally starts at 8 because items 1–7 are inside a conditional <!-- env:cloud --> block that markdownlint cannot parse. The original file had the same pattern with items 11–12; this PR continues it with items 11–14. No action needed.

11. (Optional) For **Search Analytics API Requests Per Minute**, you may configure the maximum number of requests per minute for Search Analytics API calls. The default value (1200) matches Google's documented maximum quota. If you are experiencing rate limit errors, you may need to lower this value. Most new Google Cloud projects start with a quota of 60 requests per minute. Check your Google Cloud Console quotas to see your actual limit. Refer to the [Rate Limiting](#rate-limiting) section below for more information.
12. Click **Set up source** and wait for the tests to complete.
11. (Optional) For **Number of Concurrent Workers**, you may configure the number of worker threads used during sync. The default is 40. If you are syncing a large number of site URLs or experiencing rate limit errors, you may want to reduce this value.
12. (Optional) For **Always Use Aggregation Type Auto**, enable this setting if your search analytics streams fail with a 400 error related to an unsupported `aggregationType`. This overrides the default aggregation type with `auto`, which resolves the error for certain site configurations.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 5; Actual: 12; Style: 1/2/3]

12. Click **Set up source** and wait for the tests to complete.
11. (Optional) For **Number of Concurrent Workers**, you may configure the number of worker threads used during sync. The default is 40. If you are syncing a large number of site URLs or experiencing rate limit errors, you may want to reduce this value.
12. (Optional) For **Always Use Aggregation Type Auto**, enable this setting if your search analytics streams fail with a 400 error related to an unsupported `aggregationType`. This overrides the default aggregation type with `auto`, which resolves the error for certain site configurations.
13. (Optional) For **Search Analytics API Requests Per Minute**, you may configure the maximum number of requests per minute for Search Analytics API calls. The default value of 1200 matches Google's documented maximum quota. If you are experiencing rate limit errors, you may need to lower this value. Most new Google Cloud projects start with a quota of 60 requests per minute. Check your Google Cloud Console quotas to see your actual limit. Refer to the [Rate Limiting](#rate-limiting) section below for more information.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 6; Actual: 13; Style: 1/2/3]

11. (Optional) For **Number of Concurrent Workers**, you may configure the number of worker threads used during sync. The default is 40. If you are syncing a large number of site URLs or experiencing rate limit errors, you may want to reduce this value.
12. (Optional) For **Always Use Aggregation Type Auto**, enable this setting if your search analytics streams fail with a 400 error related to an unsupported `aggregationType`. This overrides the default aggregation type with `auto`, which resolves the error for certain site configurations.
13. (Optional) For **Search Analytics API Requests Per Minute**, you may configure the maximum number of requests per minute for Search Analytics API calls. The default value of 1200 matches Google's documented maximum quota. If you are experiencing rate limit errors, you may need to lower this value. Most new Google Cloud projects start with a quota of 60 requests per minute. Check your Google Cloud Console quotas to see your actual limit. Refer to the [Rate Limiting](#rate-limiting) section below for more information.
14. Click **Set up source** and wait for the tests to complete.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 7; Actual: 14; Style: 1/2/3]

@devin-ai-integration devin-ai-integration Bot added area/documentation Improvements or additions to documentation team/documentation auto-merge labels Mar 30, 2026
@octavia-bot
octavia-bot Bot marked this pull request as ready for review March 30, 2026 20:17
@github-actions

Copy link
Copy Markdown
Contributor

Deploy preview for airbyte-docs ready!

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

Built with commit 3e4936b.
This pull request is being automatically deployed with vercel-action

@octavia-bot-hoard
octavia-bot-hoard Bot merged commit 3e00f40 into master Mar 30, 2026
62 checks passed
@octavia-bot-hoard
octavia-bot-hoard Bot deleted the devin/1774901579-gsc-docs-update branch March 30, 2026 22:15
dilanalex pushed a commit to dilanalex/airbyte that referenced this pull request Apr 6, 2026
…cument missing config options (airbytehq#75631)

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: bot_apk <apk@cognition.ai>
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