MeltanoLabs / MeltanoLabs/Singer-Working-Group

Discoverable capabilities and settings (`--about` support in CLI)

Open
#8 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Applies To::Taps Applies To::Targets Issue Type::Proposal Proposal Type::New Capability
Dominant language
No language data
Stars
15
Forks
4
PR merge metrics
No merged PRs in 30d

Description

In order for taps and targets to confidently support spec extensions in a backwards compatible way, we'll need a way to taps and targets to advertise their capabilities and list of supported settings.

The SDK handles this with (--about and --about --format=json) but we should agree on a standard (like the --discover flag) which the community can rely on.

Note: The SDK also uses --about to advertise supported config settings. We can discuss that topic here as well, but we may split into a separate issue if scope is too broad.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the SDK's --about and --about --format=json behavior with the proposed --discover flag for taps and targets. Review the issue's discussion scope around advertising capabilities and supported settings; done means the community has agreed on a standard that supports backwards-compatible spec extensions.

Written by the indexing model from the issue text.

Assessment

Domain
cli, data-engineering
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.