Skip to content

docs(source-brevo): improve documentation with setup guide, stream details, and rate limits - #75980

Closed
devin-ai-integration[bot] wants to merge 1 commit into
masterfrom
devin/1775060831-docs-source-brevo
Closed

devin-ai-integration[bot] wants to merge 1 commit into
masterfrom
devin/1775060831-docs-source-brevo

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Apr 1, 2026 •

Copy link
Copy Markdown
Contributor

Documentation Confidence Assessment

Overall Confidence: 4/5

Dimension Score Rationale
Code Comprehension 5/5 Manifest-only YAML; all 22 streams, auth, pagination, and error handling are fully declarative with no custom code.
API Documentation Quality 5/5 Comprehensive official Brevo API docs with auth guide, rate limits, and endpoint references; metadata.yaml lists 4 external doc URLs.
Change Scope & Risk 3/5 Moderate rewrite replacing auto-generated boilerplate with structured doc (80 lines added, 41 removed).
Existing Doc Maturity 2/5 Previous doc was 95 lines of sparse auto-generated content with no setup instructions and incorrect sync mode data.
Connector Sensitivity 5/5 Community connector with low usage (ql=100, sl=100).
Triggering Context 5/5 Triggered from a small merged PR (SDM base image bump, #75946).

What I Verified vs. What I Inferred

  • Verified from code: All 22 stream names, API paths, primary keys, pagination types, incremental cursor fields, substream parent relationships, authentication method (API key in api-key header), base URL, error handling (429 with exponential backoff), and start_date config format — all read directly from manifest.yaml.
  • Verified from API docs: Authentication setup steps (SMTP & API settings page), rate limits (100 RPH general, 36,000 RPH for contacts endpoints), and API endpoint URL patterns.
  • Inferred: The exact Brevo API reference URL slugs for each stream (e.g., get_contacts-attributes) follow the Brevo docs URL pattern but were not individually click-verified for all 22 streams.

Areas of Concern

  • Spot-check a few Brevo API reference URLs in the stream table to confirm they resolve correctly.

What

Rewrites the source-brevo user documentation, which was auto-generated boilerplate, into a structured connector doc following Airbyte conventions. Also corrects the changelog date for v0.2.30 (was 2026-03-31, actual merge date is 2026-04-01).

Triggered by commit 3f81be2 (#75946).

How

Single-file change to docs/integrations/sources/brevo.md:

  • Added overview paragraph, Prerequisites section, and step-by-step Setup guide with API key generation instructions
  • Replaced the auto-generated streams table (which had incorrect sync mode info — contacts_attributes was marked ❌/❌ despite supporting Full Refresh) with a detailed table including API endpoint links, sync modes, primary keys, incremental cursors, and substream relationships
  • Added Supported sync modes section and Limitations/Rate limits section based on Brevo API rate limit docs
  • Fixed changelog date for v0.2.30: 2026-03-31 → 2026-04-01 to match the actual PR merge date
  • Added <HideInUI> tags so the setup guide renders in Airbyte Cloud UI while detailed stream/limitations info is available in the full docs site

Review guide

  1. docs/integrations/sources/brevo.md — the only file changed

Key items for review:

  • Verify a few Brevo API reference URLs in the stream table resolve correctly (e.g. https://developers.brevo.com/reference/get-contacts)
  • Confirm stream sync modes and incremental cursors match the connector's manifest.yaml
  • The old contacts_attributes row marked Full Sync ❌ / Incremental ❌ was incorrect; this PR corrects it to Full Refresh ✅

User Impact

Users of source-brevo get improved documentation with clear setup steps, accurate stream information, and rate limit guidance. No connector behavior changes.

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/4fc2bc373ce943fca36dba45a8071df2

…tails, and rate limits

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

@octavia-bot
octavia-bot Bot marked this pull request as draft April 1, 2026 16:30
@octavia-bot

octavia-bot Bot commented Apr 1, 2026

Copy link
Copy Markdown
Contributor

Note

📝 PR Converted to Draft

More info...

Thank you for creating this PR. As a policy to protect our engineers' time, Airbyte requires all PRs to be created first in draft status. Your PR has been automatically converted to draft status in respect for this policy.

As soon as your PR is ready for formal review, you can proceed to convert the PR to "ready for review" status by clicking the "Ready for review" button at the bottom of the PR page.

To skip draft status in future PRs, please include [ready] in your PR title or add the skip-draft-status label when creating your PR.

@github-actions

github-actions Bot commented Apr 1, 2026

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.
      • Bump types: patch (default), minor, major, major_rc, rc, promote.
      • The rc type is a smart default: applies minor_rc if stable, or bumps the RC number if already RC.
      • The promote type strips the RC suffix to finalize a release.
      • Example: /bump-version type=rc or /bump-version type=minor
    • /bump-progressive-rollout-version - Alias for /bump-version type=rc. Bumps with an RC suffix and enables progressive rollout.
  • ❇️ 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.
  • ☕️ 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 Apr 1, 2026
@octavia-bot
octavia-bot Bot marked this pull request as ready for review April 1, 2026 16:32
@devin-ai-integration
devin-ai-integration Bot marked this pull request as draft April 1, 2026 16:32
@github-actions

github-actions Bot commented Apr 1, 2026

Copy link
Copy Markdown
Contributor

Deploy preview for airbyte-docs ready!

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

Built with commit 0fdcdaa.
This pull request is being automatically deployed with vercel-action

@octavia-bot-hoard
octavia-bot-hoard Bot marked this pull request as ready for review April 1, 2026 18:21

@octavia-bot-admin octavia-bot-admin Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Auto-approved by auto-merge workflow.

@octavia-bot-admin octavia-bot-admin Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Auto-approved by auto-merge workflow.

@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

Closing in favor of a newer autodoc PR for this connector.

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