Skip to content

docs(connectors): add teams/twilio/jira/linear/notion reference docs (drift backlog batch 1)#632

Merged
masukai merged 1 commit into
mainfrom
docs/connector-docs-backlog-batch1
Jun 11, 2026
Merged

docs(connectors): add teams/twilio/jira/linear/notion reference docs (drift backlog batch 1)#632
masukai merged 1 commit into
mainfrom
docs/connector-docs-backlog-batch1

Conversation

@masukai

@masukai masukai commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Summary

Burns down the scripts/check_drift.sh baseline from 14 → 9 by writing the first batch of the missing connector docs. These five core / API destinations predated the docs/connectors/ convention and had no dedicated reference.

What's documented

Each doc follows the slack.md shape (blurb / YAML example / config table / auth / common patterns / notes / references) and captures the per-destination specifics that are otherwise only visible in source:

Doc Specifics surfaced
teams.md plain-text vs adaptive_card JSON payload wrapping
twilio.md HTTP Basic (SID/token), E.164 requirement on from_number + rendered to_template, Messages endpoint
jira.md create-by-default vs issue_id_field-triggered update mode (POST vs PUT on /rest/api/3/issue), email + API token Basic
linear.md GraphQL issueCreate (create-only), team/label/assignee UUIDs + the queries to fetch them
notion.md properties_template per-type JSON shapes, Notion-Version: 2022-06-28 header, must-share-database-with-integration 404 gotcha, tojson_safe note

All five were cross-checked against their config models (drt/config/models.py) and implementations (endpoints, auth shape, create/update logic) — not written from API memory.

Baseline ratchet

scripts/drift_baseline.txt drops 5 entries; 9 remain (discord / email_smtp / file / github_actions / google_ads / intercom / parquet / sendgrid / staged_upload) — tracked for future batches.

Test plan

  • make check-drift — exits 0 (the 5 new docs are recognized, baseline reduced)
  • No code changes — docs + baseline + CHANGELOG only
  • CI green

Context

Follows the drift-audit automation (#630) — this is the intended workflow: the audit surfaces the doc gap, the baseline tracks it, and batches burn it down over time.

🤖 Generated with Claude Code

…(drift backlog batch 1)

Burns down the scripts/check_drift.sh baseline from 14 → 9. These five
core / API destinations predated the docs/connectors/ convention and
had no dedicated reference.

Each follows the slack.md shape (blurb / YAML example / config table /
auth / common patterns / notes / references) and documents the
per-destination specifics that are otherwise only visible in source:

- **teams** — plain-text vs adaptive_card JSON payload wrapping
- **twilio** — HTTP Basic (SID/token) + E.164 requirement on
  from_number and the rendered to_template; api.twilio.com/2010-04-01
  Messages endpoint
- **jira** — create-by-default, issue_id_field-triggered update mode
  (POST vs PUT on /rest/api/3/issue); Atlassian email + API token Basic
- **linear** — GraphQL issueCreate (create-only), team/label/assignee
  UUIDs + the queries to fetch them
- **notion** — properties_template per-type JSON shapes, the
  Notion-Version: 2022-06-28 header, and the must-share-database-with-
  integration 404 gotcha; tojson_safe note for datetime/Decimal/UUID

drift_baseline.txt updated (5 entries removed; remaining 9 noted in the
header). `make check-drift` exits 0. No code changes.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@masukai masukai requested a review from yodakanohoshi June 10, 2026 07:35
@codecov

codecov Bot commented Jun 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@masukai masukai merged commit 1ee1aae into main Jun 11, 2026
8 checks passed
@masukai masukai deleted the docs/connector-docs-backlog-batch1 branch June 11, 2026 00:42
@github-actions github-actions Bot locked and limited conversation to collaborators Jun 11, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant