Skip to content

Update README.md#3

Merged
simonjanin merged 1 commit into
mainfrom
simonjanin-patch-1
Jun 27, 2026
Merged

Update README.md#3
simonjanin merged 1 commit into
mainfrom
simonjanin-patch-1

Conversation

@simonjanin

Copy link
Copy Markdown
Contributor

No description provided.

@simonjanin
simonjanin merged commit c91d5e1 into main Jun 27, 2026
2 checks passed
@github-actions

Copy link
Copy Markdown

Coverage Report

✓ PASS — 221/263 endpoints covered (84.0%)
Source modules walked: 38
Deferred (allowlisted): 42
Gaps (uncovered): 0

Deferred (allowlisted)

  • POST /admin/auth/domains/activate — infra: admin/ops endpoint (X-Admin-Secret); flips a custom auth domain to active after TLS provisioning, called by scripts/ops/auth-custom-domain.sh
  • GET /auth/google/callback — web-only-auth: fixed managed-Google OAuth callback (tenant resolved from state); browser redirect target
  • GET /auth/{tenant}/.well-known/openid-configuration — public-endpoint: OIDC discovery; consumed by app OIDC client libraries, not the CLI
  • GET /auth/{tenant}/authorize — web-only-auth: OIDC authorization endpoint; browser redirect target of the hosted login page
  • GET /auth/{tenant}/forgot-password — web-only-auth: hosted forgot-password page; browser-rendered
  • GET /auth/{tenant}/jwks — public-endpoint: OIDC JWKS (token-signing public keys); apps verify tokens against it, not the CLI
  • GET /auth/{tenant}/magic/callback — web-only-auth: magic-link callback clicked by the end user
  • POST /auth/{tenant}/magic/start — web-only-auth: magic-link start; the hosted login page sends the email
  • POST /auth/{tenant}/password/login — web-only-auth: hosted-login-page password sign-in; browser form post
  • POST /auth/{tenant}/password/reset — web-only-auth: hosted-login-page reset submit; browser form post
  • POST /auth/{tenant}/password/reset-request — web-only-auth: hosted-login-page reset request; browser form post
  • POST /auth/{tenant}/password/signup — web-only-auth: hosted-login-page password sign-up; browser form post
  • GET /auth/{tenant}/reset-password — web-only-auth: hosted reset-password page; browser-rendered
  • POST /auth/{tenant}/token — public-endpoint: OIDC token endpoint; called by the app's OIDC client, not the CLI
  • GET /auth/{tenant}/userinfo — public-endpoint: OIDC userinfo; called by the app with an access token, not the CLI
  • GET /auth/{tenant}/verify-email — web-only-auth: email-verification callback link clicked by the end user
  • GET /email/unsubscribe/{tok} — public-endpoint: direct-link unsubscribe (recipient clicks from email); browser target, not CLI
  • POST /email/unsubscribe/{tok} — public-endpoint: RFC 8058 one-click unsubscribe (mail clients POST automatically); not CLI-driven
  • POST /email/webhook/ses — webhook-receiver: SES → MyAPI email events; never called from CLI
  • POST /funnel/funnels/{id}/event — public-endpoint: pixel/event ingest from published funnel pages; not a user-facing CLI capability
  • POST /funnel/funnels/{id}/submit/{slug} — public-endpoint: form submission from published funnel pages; receives traffic
  • DELETE /hq/account — web-only-auth: self-service account deletion is destructive and irreversible-via-API; kept to the web app rather than a CLI verb
  • POST /hq/account/login — web-only-auth: web-app login flow; CLI uses bearer tokens directly
  • POST /hq/account/refresh — web-only-auth: web session refresh; CLI uses long-lived API keys
  • POST /hq/account/register — web-only-auth: email+password registration; CLI uses anonymous account upgrade flow instead
  • GET /hq/account/verify-email — web-only-auth: email verification callback; CLI uses send-code/verify-code flow
  • GET /hq/auth/google/callback — web-only-auth: OAuth callback target; not initiated by CLI users
  • GET /hq/auth/google/redirect — web-only-auth: OAuth redirect entry point; not initiated by CLI users
  • POST /hq/billing/setup-payment/confirm — webhook-receiver: Stripe confirmation callback; never called from CLI
  • POST /hq/billing/webhook — webhook-receiver: Stripe → MyAPI webhook; never called from CLI
  • GET /hq/healthz — infra: health check; not a user-facing capability
  • GET /image/orgs/{org_id}/generate/{id} — documentation-alias: REST-instinct alias for GET /image/orgs/{org_id}/jobs/{id} (already covered by image get-job <id>); same handler
  • POST /llm/orgs/{org_id}/chat/completions — openai-compat: drop-in for the OpenAI SDK — users set base_url and invoke via their OpenAI client, not the CLI
  • POST /llm/orgs/{org_id}/v1/chat/completions — openai-compat: /v1 alias of chat/completions for SDKs that hard-code /v1; same as above
  • GET /ops/status — infra: ops/SRE status; not a user-facing capability
  • GET /schema/v1/docs — meta: human-readable API docs page; browser-rendered, not a CLI command
  • GET /schema/v1/openapi.json — meta: the schema endpoint itself; the coverage tool consumes it but doesn't need a CLI command
  • GET /storage/{id} — public-endpoint: signed/public asset URL access; consumers fetch directly, not via CLI
  • GET /t/o — public-endpoint: pixel tracking redirect
  • GET /t/p — public-endpoint: pixel tracking redirect
  • POST /webhook/in/{slug} — webhook-receiver: user-configured inbound webhooks; receives traffic, not initiated by CLI users
  • GET /{domain}/{code} — public-endpoint: shortened-URL redirect; resolved by browsers, not CLI

SDK Parity (informational, non-blocking)

211/263 schema endpoints reachable via SDK functions (80.2%).
SDK service modules walked: 23

Endpoints in schema but not in any SDK module

  • POST /admin/auth/domains/activate
  • GET /auth/google/callback
  • GET /auth/{tenant}/.well-known/openid-configuration
  • GET /auth/{tenant}/authorize
  • GET /auth/{tenant}/forgot-password
  • GET /auth/{tenant}/jwks
  • GET /auth/{tenant}/magic/callback
  • POST /auth/{tenant}/magic/start
  • POST /auth/{tenant}/password/login
  • POST /auth/{tenant}/password/reset
  • POST /auth/{tenant}/password/reset-request
  • POST /auth/{tenant}/password/signup
  • GET /auth/{tenant}/reset-password
  • POST /auth/{tenant}/token
  • GET /auth/{tenant}/userinfo
  • GET /auth/{tenant}/verify-email
  • GET /crm/orgs/{org_id}/companies
  • POST /crm/orgs/{org_id}/companies/{id}/restore
  • GET /crm/orgs/{org_id}/contacts
  • POST /crm/orgs/{org_id}/contacts/{id}/restore
  • DELETE /email/mailboxes/{address}
  • POST /email/orgs/{org_id}/domains/{domain}/mail-server-resync
  • GET /email/unsubscribe/{tok}
  • POST /email/unsubscribe/{tok}
  • POST /email/webhook/ses
  • POST /funnel/funnels/{id}/event
  • POST /funnel/funnels/{id}/submit/{slug}
  • DELETE /hq/account
  • POST /hq/account/login
  • POST /hq/account/refresh
  • POST /hq/account/register
  • GET /hq/account/verify-email
  • GET /hq/auth/google/callback
  • GET /hq/auth/google/redirect
  • GET /hq/billing/auto-recharge
  • PUT /hq/billing/auto-recharge
  • DELETE /hq/billing/auto-recharge
  • POST /hq/billing/setup-payment/confirm
  • POST /hq/billing/webhook
  • GET /hq/healthz
  • GET /image/orgs/{org_id}/generate/{id}
  • POST /llm/orgs/{org_id}/chat/completions
  • POST /llm/orgs/{org_id}/v1/chat/completions
  • GET /ops/status
  • GET /schema/v1/docs
  • GET /schema/v1/openapi.json
  • GET /storage/{id}
  • GET /t/o
  • GET /t/p
  • POST /v1/integrations/skills-install
  • POST /webhook/in/{slug}
  • GET /{domain}/{code}

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.

1 participant