Jordan-Hall / Jordan-Hall/browser

[P1][CONN-01] Connector SDK, registry and manifests

Open
#45 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Programme: #1
Epic: #18

## Objective
Define the typed connector contract that turns services into discoverable data/action providers without assuming one universal domain model.

## Scope
- Connector manifest with provider/version, resource schemas, read/write actions, auth requirements and support level.
- Pagination/cursor semantics, freshness/TTL policy, subscriptions/webhooks/polling, rate limits and retry guidance.
- Error taxonomy, idempotency/reconciliation metadata, effect class, timeout and verification method per action.
- Capability registration into the policy broker.
- Provider/domain extensions alongside common resource types.
- Resettable connector contract-test harness.

## Design rules
- Read and write capabilities are declared separately.
- Tool discovery never grants trust or authority.
- Operations expose provider/account semantics that cannot be safely normalized away.

## Acceptance criteria
- [ ] Every operation declares exact input/output schema, scope, effect class, limits and verification strategy.
- [ ] Connector installation registers capabilities without granting them.
- [ ] Pagination, rate-limit and structured error behavior pass resettable contract tests.
- [ ] Unsupported or experimental operations expose truthful support status.
- [ ] Schema/version negotiation fails visibly rather than silently coercing incompatible data.
- [ ] Reference connector can read normalized resources into DATA-01 without losing provider IDs.

## Dependencies
- CORE-01
- SEC-02

**First phase:** P1
**Maturity target:** P2
**Owner:** connectors-domains

## Task issues
- [ ] #374 `CONN-01.T01` — Define manifests and domain schema registration
- [ ] #375 `CONN-01.T02` — Implement connector worker lifecycle
- [ ] #376 `CONN-01.T03` — Implement read/query and pagination contracts
- [ ] #377 `CONN-01.T04` — Implement typed action and verifier registration
- [ ] #378 `CONN-01.T05` — Implement events, freshness and rate-limit semantics
- [ ] #379 `CONN-01.T06` — Publish structured errors and compatibility diagnostics
- [ ] #380 `CONN-01.T07` — Build the reference connector and conformance kit

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with task issue #374 and the dependency contracts CORE-01 and SEC-02; the payload names no repository files or test entry points. Use the acceptance criteria as the completion checklist, including capability registration without authority, resettable contract tests, visible compatibility failures, and the reference connector preserving provider IDs.

Written by the indexing model from the issue text.

Assessment

Domain
backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.