Skip to content

Conversation

@lmossman
Copy link
Contributor

@lmossman lmossman commented Jul 18, 2025

This PR marks more fields in the declarative component schema with linkable: true, which allows those fields to be "linked" together in the Builder UI, which means changing that field in one stream will also change it in any other streams that have enabled linking for that field.

Screenshot 2025-07-18 at 10 34 34 AM

Summary by CodeRabbit

  • New Features
    • Introduced a new property marking several components as linkable within the declarative source manifest, enhancing schema metadata without affecting functionality or validation.

@github-actions
Copy link

👋 Greetings, Airbyte Team Member!

Here are some helpful tips and reminders for your convenience.

Testing This CDK Version

You can test this version of the CDK using the following:

# Run the CLI from this branch:
uvx 'git+https://github.com/airbytehq/airbyte-python-cdk.git@07-18-mark_more_fields_linkable#egg=airbyte-python-cdk[dev]' --help

# Update a connector to use the CDK from this branch ref:
cd airbyte-integrations/connectors/source-example
poe use-cdk-branch 07-18-mark_more_fields_linkable

Helpful Resources

PR Slash Commands

Airbyte Maintainers can execute the following slash commands on your PR:

  • /autofix - Fixes most formatting and linting issues
  • /poetry-lock - Updates poetry.lock file
  • /test - Runs connector tests with the updated CDK
  • /poe <command> - Runs any poe command in the CDK environment

📝 Edit this welcome message.

Copy link
Contributor Author

lmossman commented Jul 18, 2025

@lmossman lmossman changed the title mark more fields linkable feat: mark more fields linkable Jul 18, 2025
@github-actions
Copy link

github-actions bot commented Jul 18, 2025

PyTest Results (Fast)

3 695 tests  ±0   3 684 ✅ ±0   6m 22s ⏱️ -3s
    1 suites ±0      11 💤 ±0 
    1 files   ±0       0 ❌ ±0 

Results for commit ca241b6. ± Comparison against base commit d3d94df.

♻️ This comment has been updated with latest results.

@lmossman lmossman force-pushed the 07-18-mark_more_fields_linkable branch from b311858 to 49e65f3 Compare July 18, 2025 17:40
@github-actions github-actions bot added the enhancement New feature or request label Jul 18, 2025
@lmossman lmossman force-pushed the 07-18-mark_more_fields_linkable branch 2 times, most recently from 2cef81d to 3f09ed6 Compare July 18, 2025 17:49
@lmossman lmossman marked this pull request as ready for review July 18, 2025 17:50
@lmossman lmossman requested a review from ChristoGrab July 18, 2025 17:50
@lmossman lmossman force-pushed the 07-18-mark_more_fields_linkable branch from 3f09ed6 to 27a4cec Compare July 18, 2025 18:01
Copy link
Collaborator

@ChristoGrab ChristoGrab left a comment

Choose a reason for hiding this comment

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

:shipit:

I am so pumped for what you're cooking in builder 😄

@github-actions
Copy link

github-actions bot commented Jul 18, 2025

PyTest Results (Full)

3 698 tests  ±0   3 687 ✅ ±0   17m 53s ⏱️ -11s
    1 suites ±0      11 💤 ±0 
    1 files   ±0       0 ❌ ±0 

Results for commit ca241b6. ± Comparison against base commit d3d94df.

♻️ This comment has been updated with latest results.

@lmossman lmossman force-pushed the 07-18-mark_more_fields_linkable branch 2 times, most recently from 750b4fc to 896ad5e Compare July 18, 2025 18:47
@lmossman lmossman changed the base branch from 07-17-update_descriptions_defaults_and_examples_of_complex_fields to graphite-base/664 July 18, 2025 19:19
@lmossman lmossman force-pushed the graphite-base/664 branch from 683b60b to d3d94df Compare July 18, 2025 19:19
@lmossman lmossman force-pushed the 07-18-mark_more_fields_linkable branch from 896ad5e to 1c4901b Compare July 18, 2025 19:19
@graphite-app graphite-app bot changed the base branch from graphite-base/664 to main July 18, 2025 19:19
@lmossman lmossman force-pushed the 07-18-mark_more_fields_linkable branch from 1c4901b to c52fc61 Compare July 18, 2025 19:19
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 18, 2025

📝 Walkthrough

Walkthrough

The schema file for declarative components was updated to add a linkable: true boolean property to several component definitions. This change marks specific properties as linkable entities within the schema but does not modify their structure, validation logic, or control flow.

Changes

File Change Summary
airbyte_cdk/sources/declarative/declarative_component_schema.yaml Added linkable: true to properties in DeclarativeStream (incremental_sync, transformations, file_uploader), HttpRequester (request_parameters, request_headers, request_body, error_handler), and SimpleRetriever (paginator, partition_router).

Suggested labels

declarative-component-schema, airbyte-python-cdk

Suggested reviewers

  • aldogonzalez8

Would you like to highlight these new linkable properties in the documentation or changelog as well, to help users discover this capability more easily? Wdyt?


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c52fc61 and ca241b6.

📒 Files selected for processing (1)
  • airbyte_cdk/sources/declarative/declarative_component_schema.yaml (9 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • airbyte_cdk/sources/declarative/declarative_component_schema.yaml
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)
  • GitHub Check: Check: source-intercom
  • GitHub Check: Check: source-pokeapi
  • GitHub Check: Check: destination-motherduck
  • GitHub Check: Check: source-hardcoded-records
  • GitHub Check: Check: source-shopify
  • GitHub Check: Pytest (Fast)
  • GitHub Check: Pytest (All, Python 3.10, Ubuntu)
  • GitHub Check: Pytest (All, Python 3.11, Ubuntu)
  • GitHub Check: SDM Docker Image Build
  • GitHub Check: Analyze (python)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
airbyte_cdk/sources/declarative/declarative_component_schema.yaml (1)

2132-2136: HTTP requester pieces made linkable – consider deprecated siblings?

request_parameters, request_headers, request_body, and error_handler are now linkable – great.
One open question: the deprecated request_body_data / request_body_json fields are still visible in some manifests. Should they also get the flag for parity, or do we intentionally leave them out to nudge users to the new field – wdyt?

Also applies to: 2155-2159, 2215-2219, 2229-2233

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d3d94df and c52fc61.

📒 Files selected for processing (1)
  • airbyte_cdk/sources/declarative/declarative_component_schema.yaml (9 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: ChristoGrab
PR: airbytehq/airbyte-python-cdk#58
File: airbyte_cdk/sources/declarative/yaml_declarative_source.py:0-0
Timestamp: 2024-11-18T23:40:06.391Z
Learning: When modifying the `YamlDeclarativeSource` class in `airbyte_cdk/sources/declarative/yaml_declarative_source.py`, avoid introducing breaking changes like altering method signatures within the scope of unrelated PRs. Such changes should be addressed separately to minimize impact on existing implementations.
airbyte_cdk/sources/declarative/declarative_component_schema.yaml (4)

undefined

<retrieved_learning>
Learnt from: ChristoGrab
PR: #58
File: airbyte_cdk/sources/declarative/yaml_declarative_source.py:0-0
Timestamp: 2024-11-18T23:40:06.391Z
Learning: When modifying the YamlDeclarativeSource class in airbyte_cdk/sources/declarative/yaml_declarative_source.py, avoid introducing breaking changes like altering method signatures within the scope of unrelated PRs. Such changes should be addressed separately to minimize impact on existing implementations.
</retrieved_learning>

<retrieved_learning>
Learnt from: pnilan
PR: airbytehq/airbyte-python-cdk#0
File: :0-0
Timestamp: 2024-12-11T16:34:46.319Z
Learning: In the airbytehq/airbyte-python-cdk repository, the declarative_component_schema.py file is auto-generated from declarative_component_schema.yaml and should be ignored in the recommended reviewing order.
</retrieved_learning>

<retrieved_learning>
Learnt from: aaronsteers
PR: #58
File: airbyte_cdk/cli/source_declarative_manifest/_run.py:62-65
Timestamp: 2024-11-15T01:04:21.272Z
Learning: The files in airbyte_cdk/cli/source_declarative_manifest/, including _run.py, are imported from another repository, and changes to these files should be minimized or avoided when possible to maintain consistency.
</retrieved_learning>

<retrieved_learning>
Learnt from: aaronsteers
PR: #58
File: airbyte_cdk/cli/source_declarative_manifest/spec.json:9-15
Timestamp: 2024-11-15T00:59:08.154Z
Learning: When code in airbyte_cdk/cli/source_declarative_manifest/ is being imported from another repository, avoid suggesting modifications to it during the import process.
</retrieved_learning>

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
  • GitHub Check: Check: source-pokeapi
  • GitHub Check: Check: source-intercom
  • GitHub Check: Check: source-hardcoded-records
  • GitHub Check: Check: source-shopify
  • GitHub Check: Pytest (Fast)
  • GitHub Check: Pytest (All, Python 3.11, Ubuntu)
  • GitHub Check: Pytest (All, Python 3.10, Ubuntu)
  • GitHub Check: SDM Docker Image Build
🔇 Additional comments (7)
airbyte_cdk/sources/declarative/declarative_component_schema.yaml (7)

1512-1516: Incremental sync now linkable – looks good

The extra linkable: true flag here will let Builder keep different streams in-sync – no concerns on the YAML itself.


1545-1549: Transformations marked linkable – nice catch

This unlocks some handy UX in the UI, LGTM.


1569-1573: File-uploader linkable flag added

Looks right and indentation is correct.


3670-3673: Record-selector linkable – 👍


3674-3677: Paginator linkable – 👍


3684-3689: Partition-router linkable – 👍


1-10: Don’t forget to re-generate the Python artefact

declarative_component_schema.py is auto-generated from this YAML. After merging, can we run the generation script (or make generate-schemas) so the Python copy stays in sync – wdyt?

@lmossman lmossman merged commit 14bef12 into main Jul 18, 2025
25 of 26 checks passed
@lmossman lmossman deleted the 07-18-mark_more_fields_linkable branch July 18, 2025 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants