fix: (CDK) (DpathExtractor) - fix schema causing the typescript type generation in the FE

[bazarnov]

What

Resolving:

• https://github.com/airbytehq/airbyte-internal-issues/issues/11913

How

• corrected the notation from - type: string to type: string instead (hyphen has been removed)

User Impact

No impact is expected, this is not a breaking change.

Summary by CodeRabbit

• Refactor
  • Streamlined the configuration schema to simplify how list values are defined, enhancing clarity and consistency.

[Copilot]

Pull Request Overview

This PR resolves a schema notation issue in the YAML file that was causing TypeScript type generation issues in the front-end.

• Corrected the schema notation by removing an extraneous hyphen.

Comments suppressed due to low confidence (1)

airbyte_cdk/sources/declarative/declarative_component_schema.yaml:1660

• Removing the extraneous '-' for the type definition improves the YAML schema structure and should resolve the type generation issue. Please ensure that this schema change aligns with all expectations for the declarative component schema.

type: string

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request modifies the YAML schema for the AddFields and SchemaTypeIdentifier components within the declarative component schema. It simplifies the definitions by changing the items property from a nested array structure to a direct reference. This adjustment streamlines the schema representation for these properties.

Changes

File(s)	Change Summary
airbyte_cdk/.../declarative_component_schema.yaml	Updated the AddFields definition by simplifying the fields items property from a nested array to a flat structure. Updated the SchemaTypeIdentifier definition by simplifying the types_mapping items property similarly.

Suggested reviewers

• natikgadzhi – Would you consider reviewing this change, wdyt?
• maxi297 – Does this reviewer seem like a good fit, wdyt?
• aaronsteers – Would you like to add them as a reviewer, 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 e12445e and 879ceb0.

📒 Files selected for processing (3)

• airbyte_cdk/sources/declarative/declarative_component_schema.yaml (1 hunks)
• airbyte_cdk/sources/declarative/declarative_component_schema.yaml (4 hunks)
• airbyte_cdk/sources/declarative/declarative_component_schema.yaml (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• airbyte_cdk/sources/declarative/declarative_component_schema.yaml
• airbyte_cdk/sources/declarative/declarative_component_schema.yaml

⏰ Context from checks skipped due to timeout of 90000ms (8)

• GitHub Check: Check: 'source-pokeapi' (skip=false)
• GitHub Check: Check: 'source-amplitude' (skip=false)
• GitHub Check: Check: 'source-shopify' (skip=false)
• GitHub Check: Check: 'source-hardcoded-records' (skip=false)
• 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 (1)

airbyte_cdk/sources/declarative/declarative_component_schema.yaml (1)

1660-1660: Refined Schema Notation for DpathExtractor's Field Path Items
The change from using a nested list (i.e. using “- type: string”) to a single-level declaration (“type: string”) clearly simplifies the schema for the field_path items in the DpathExtractor definition. This change should help resolve the TypeScript type generation issue as intended.
Would you mind double-checking that this alteration is consistent with other similar array definitions within the schema and meets the expected type validation for your front-end generation? wdyt?

---

🪧 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 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.

[lmossman]

@bazarnov FYI I also pushed up this commit to fix a couple more places I found with the same issue, though in those places they were using $refs instead of type: string