Skip to content

refactor(api): name members, organizations, private-channels and admi… - #2929

Open
cutbow7 wants to merge 2 commits into
codex/api-review-4-custody-walletsfrom
codex/api-review-5-platform
Open

cutbow7 wants to merge 2 commits into
codex/api-review-4-custody-walletsfrom
codex/api-review-5-platform

Conversation

@cutbow7

@cutbow7 cutbow7 commented Nov 20, 2026

Copy link
Copy Markdown
Contributor

…n routes

Carve-out 5/6 of the API endpoint review (PR #2697), platform surfaces:

  • members: /v1/members/invite -> /v1/members/invitations (creation sits beside revocation)
  • organizations: provider-access -> provider-availability (same term as projects)
  • private channels: instance-connection family (connect rather than deploy/destroy), verified-wallets distinct from the wallet registry, principal-memberships, eligibility and event-label names
  • helius rings: register-and-initialize, identity-scoped rekey, provision-identity setup
  • clerk webhook handler no longer claims to only link orgs; admin allowlist -> onboarding-allowlist everywhere it is mounted or served
  • regenerate served paths, catalogs and route snapshots

…n routes

Carve-out 5/6 of the API endpoint review (PR #2697), platform surfaces:
- members: /v1/members/invite -> /v1/members/invitations (creation sits
  beside revocation)
- organizations: provider-access -> provider-availability (same term as
  projects)
- private channels: instance-connection family (connect rather than
  deploy/destroy), verified-wallets distinct from the wallet registry,
  principal-memberships, eligibility and event-label names
- helius rings: register-and-initialize, identity-scoped rekey,
  provision-identity setup
- clerk webhook handler no longer claims to only link orgs; admin
  allowlist -> onboarding-allowlist everywhere it is mounted or served
- regenerate served paths, catalogs and route snapshots
@cutbow7
cutbow7 added this pull request to stack #2927 November 20, 2026 09:29
@vercel

vercel Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sdp-docs Ready Ready Preview Nov 21, 2026 10:51pm UTC
sdp-web Ready Ready Preview Nov 21, 2026 10:51pm UTC
2 Skipped Deployments
Project Deployment Actions Updated
sdp-docs-beta Ignored Ignored Preview Nov 21, 2026 10:51pm UTC
sdp-web-beta Ignored Ignored Preview Nov 21, 2026 10:51pm UTC

Request Review

@github-actions

github-actions Bot commented Nov 20, 2026 •

Copy link
Copy Markdown
Contributor

React Doctor found no new issues. 🎉

Reviewed by React Doctor for commit 4fcabf6.

@greptile-apps

greptile-apps Bot commented Nov 20, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 4/5

[Medium impact] The route renames affect several API workflows and their dashboard callers.

Update both route snapshots before merging; the added Clerk compatibility route makes their exact comparisons fail.

Summary

Renames platform API routes and updates dashboard callers, API descriptions, and setup guides.

  • Member, organization, and admin routes use clearer names.
  • Private Channels routes name connections, checks, and memberships more clearly.
  • Helius Rings paths name setup and operation actions directly.
  • The Clerk webhook uses a shorter path and keeps its old path as an alias.

Reviews (2) · Last reviewed commit: "fix(api): keep signed /webhooks/clerk/li..." · Reviewed by Greptile

@keeganthomp keeganthomp left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Clerk endpoint switch needs a coordinated rollout.


webhooks.post(
"/clerk/link-orgs",
"/clerk",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any Clerk endpoint still configured for /webhooks/clerk/link-orgs now gets 404, including the self-hosting quickstart's configuration. Keep a signed compatibility route during migration and update that guide and its generated AI docs.


webhooks.post(
"/clerk/link-orgs",
"/clerk",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new path misses sdp-infra's /webhooks/clerk/ WAF exemption. With that policy, signed events whose profile or metadata matches OWASP rules receive 403 before verification. Update the exception alongside this switch.

heliusRings.get("/operations/:operationId", requireAction("helius_rings.read"), getRingsOperation);
heliusRings.post(
"/operations/:operationId/execute",
"/operations/:operationId/resume-execution",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Rings runbook still names POST /operations/:id/execute, so following that recovery instruction now returns 404. Update it to /resume-execution alongside this rename.

…le route docs

Address the PR review: Clerk endpoints registered before the webhook
rename keep a signed compatibility route on the legacy path, which also
stays under the /webhooks/clerk/ prefix of the platform load balancer's
WAF exemption until sdp-infra widens that rule; removing the alias then
requires updating the exemption in the same change.

Update the setup and operator sources that still named removed routes:
dev-webhook.sh, .env.local.example, the self-hosting quickstart (plus
its generated llms-full.txt), the API README (clerk webhook and
admin/onboarding-allowlist paths) and the Rings runbook
(operations execute -> resume-execution). Cover the alias with a
webhook test.
@greptile-apps

greptile-apps Bot commented Nov 21, 2026

Copy link
Copy Markdown
Contributor

Comments Outside Diff

These findings could not be posted inline.

  • P1 Route snapshots miss restored endpoint apps/sdp-api/src/routes/webhooks/index.ts:63 ▶

    Adding /webhooks/clerk/link-orgs leaves both route snapshots out of date. route-actions.test.ts snapshots every public route, and route-modules.test.ts snapshots every registered endpoint. Both snapshots list only /webhooks/clerk, so these tests will fail. Update both snapshots while keeping the compatibility route.

    Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

This branch was successfully deployed

2 active deployments
Preview – sdp-docs — 4fcabf6a Deployed Nov 21, 2026 by vercel[bot]
Preview – sdp-web — 4fcabf6a Deployed Nov 21, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants