[Ian Alton (ian-at-airbyte)]

Summary

Rewrites description strings in declarative_component_schema.yaml in plain language (targeting an 8th-grade reading level). These strings render into the low-code YAML reference on docs.airbyte.com, for example ApiKeyAuthenticator:

- Authenticator for requests authenticated with an API token injected as an HTTP request header.
+ Sends an API key with each request, in a header, query parameter or body field.

Requested by Ian Alton.

• About 120 component descriptions and about 20 field descriptions rewritten. Each one starts with what the component does, in short, active sentences. Exact config names stay in code formatting. Other descriptions are unchanged.
• Some field descriptions were inaccurate and are corrected against the code:
  • HttpRequester.request_headers: auth headers don't overwrite yours. combine_mappings raises on a duplicate key.
  • RemoveFields.condition: "empty" meant the condition is unset. When it's unset, every field in field_pointers is removed.
  • RecordSelector.schema_normalization, AsyncRetriever.abort_requester and OAuthAuthenticator.profile_assertion: rewritten to match what the code does.
• models/declarative_component_schema.py is regenerated, but only description strings change. The generator's unrelated type and ordering changes were dropped, and an AST comparison confirms no other change.

No behavior changes.

Test plan

• poetry run ruff format --check . and poetry run ruff check . pass.
• poetry run pytest unit_tests/sources/declarative -x -q: 2593 passed, 1 skipped.
• The rendered docs pages have not been checked.

---

Posted by Devin, on behalf of Ian Alton.

Open in Devin Desktop: https://app.devin.ai/desktop/session/f6027708863547fcadfe500518752e81?variant=devin

[devin-ai-integration]

I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".

• Disable automatic comment, CI, and merge conflict monitoring

[github-actions]

👋 Greetings, Airbyte Team Member!

Here are some helpful tips and reminders for your convenience.

💡 Show Tips and Tricks

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@devin/1794082119-plain-yaml-reference-descriptions#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 devin/1794082119-plain-yaml-reference-descriptions

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
• /prerelease - Triggers a prerelease publish with default arguments
• /poe build - Regenerate git-committed build artifacts, such as the pydantic models which are generated from the manifest JSON schema in YAML.
• /poe <command> - Runs any poe command in the CDK environment

📚 Show Repo Guidance

Helpful Resources

• CDK API Reference

📝 Edit this welcome message.

[github-actions]

PyTest Results (Fast)

6 434 tests  ±0   6 398 ✅ +1   6m 37s ⏱️ +10s
    1 suites ±0      36 💤  - 1 
    1 files   ±0       0 ❌ ±0 

Results for commit 11b10bc. ± Comparison against base commit 314f8fb.

[github-actions]

PyTest Results (Full)

6 437 tests  ±0   6 401 ✅ +1   9m 17s ⏱️ - 2m 19s
    1 suites ±0      36 💤  - 1 
    1 files   ±0       0 ❌ ±0 

Results for commit 11b10bc. ± Comparison against base commit 314f8fb.