Skip to content

chore(source-orb): fix stale external documentation URLs in metadata.yaml - #83333

Draft
devin-ai-integration[bot] wants to merge 1 commit into
masterfrom
devin/1785737652-source-orb-external-docs-urls
Draft

chore(source-orb): fix stale external documentation URLs in metadata.yaml#83333
devin-ai-integration[bot] wants to merge 1 commit into
masterfrom
devin/1785737652-source-orb-external-docs-urls

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

What

Related to https://github.com/airbytehq/oncall/issues/13218:

The API-deprecations audit for the orb family was a no-op, but it surfaced that two externalDocumentationUrls entries in source-orb/metadata.yaml point at Orb's retired docs.withorb.com/reference/* docs site and now return 404.

Verified with curl on 2026-08-03:

URL Status
https://docs.withorb.com/reference/api-reference (current) 404
https://docs.withorb.com/reference/authentication (current) 404
https://docs.withorb.com/api-reference (new) 200
https://docs.withorb.com/essentials/authentication (new) 200
https://changelog.withorb.com/ (new) 200

How

Metadata-only change to externalDocumentationUrls: repointed the two dead URLs at their current equivalents (the authentication page was located via docs.withorb.com/sitemap.xml) and added Orb's changelog as an api_release_history entry, which is one of the allowed type enum values in the connector metadata schema.

No version bump or connector changelog entry: this follows the precedent of recent metadata-URL fixes such as #83262 (source-amazon-ads) and #82265 (source-github), which changed metadata.yaml docs URLs only. No connector code, manifest, spec, schema, or sync behavior is touched.

Test Coverage

No unit or mock-server test is added. The change contains no executable connector logic — it edits documentation URLs in metadata.yaml only. Correctness was verified by checking each URL's HTTP status directly (table above) and confirming the type values against the ConnectorMetadataDefinitionV0DataExternalDocumentationUrlType enum in the metadata schema. Metadata validation is covered by the repo's existing QA checks in CI.

Review guide

  1. airbyte-integrations/connectors/source-orb/metadata.yaml

User Impact

Users and tooling following the connector's external docs links reach live Orb documentation instead of 404 pages. No sync behavior change.

Can this PR be safely reverted and rolled back?

  • YES 💚
  • NO ❌

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

…yaml

Replace the two 404 docs.withorb.com/reference/* URLs with current equivalents and add Orb's changelog.

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, CI, and merge conflict monitoring

@github-actions

github-actions Bot commented Aug 3, 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.
  • 📝 AI Documentation:
    • /ai-docs-review - AI-powered documentation review for PRs with connector changes.
    • /ai-create-docs-pr - Creates a documentation PR for connector changes, stacked on the current PR.
  • 🚀 Connector Releases:
    • /publish-connectors-prerelease - Publishes pre-release connector builds (tagged as {version}-preview.{git-sha}) for all modified connectors in the PR.
    • /enable-autopilot-rollouts - Enables autopilot progressive rollouts for the modified connector(s) in the PR, remediating "autopilot rollouts not enabled for {connector-name}" auto-merge blockers. Sets defaultRolloutMode: autopilot and enableProgressiveRollout: true, preserving any existing autopilotConfig.
      • Optional args: connector=<CONNECTOR_NAME> (defaults to the modified connectors in the PR), strategy=fast|slow|default (defaults to fast).
      • Example: /enable-autopilot-rollouts or /enable-autopilot-rollouts connector=source-faker strategy=slow
  • ☕️ 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.

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Note

Autopilot progressive rollouts are not enabled for the following modified connector(s):

  • source-orb

This is a courtesy heads-up only — it does not block merge or fail any check.
To enable automatic progressive rollouts for the connector(s) above, comment
/enable-autopilot-rollouts on this PR. This sets defaultRolloutMode: autopilot
and enableProgressiveRollout: true in each connector's metadata.yaml,
preserving any existing autopilotConfig.

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

source-orb Connector Test Results

1 tests   0 ✅  0s ⏱️
1 suites  0 💤
1 files    0 ❌  1 🔥

For more details on these errors, see this check.

Results for commit 47e02ab.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

connectors/source/orb hyd-fix Hydra: ai-fix stage has run

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants