Skip to content

Open-source AI teammates in Slack, Teams, Discord, Telegram and Mattermost. Self-host it, with any agent harness and any model.

23.3 KB
Raw Blame
{
  "_about": "Read by src/gate/gate.ts; see the README, \"Coverage gate\". exempt and unauthenticated need a reason per entry. backlog is what no scenario covered when the gate landed: it only shrinks, and the gate fails on an entry a scenario now covers.",
  "exempt": {
    "DELETE /gateway/chats/{room_id}/agents/{agent_id}": "Switch Console group chats. Covered by core's test_chats_groups.py against real Postgres; no scenario drives Console chats yet (every other /gateway/chats route is still in the backlog), and the stacks the harness builds do not turn on the group_chats flag these routes need.",
    "DELETE /gateway/organizations/current/connector-apps/{service}": "An organization's own connector apps, behind the organization_connector_apps flag (off by default), which no stack the harness builds turns on; saving or checking one also needs a real vendor app. Covered by core's test_organization_connector_apps.py against real Postgres.",
    "DELETE /gateway/organizations/current/services/{service}": "An organization's service switches, behind the organization_connector_apps flag (off by default), which no stack the harness builds turns on. Covered by core's test_organization_services.py against real Postgres.",
    "DELETE /gateway/workspace/services/{service}": "A workspace admin dropping their own service switch to take their organization's setting; it matters only with organization_connector_apps on, which no stack the harness builds turns on (the rest of /gateway/workspace/services is still in the backlog). Covered by core's test_workspace_services.py against real Postgres.",
    "GET /gateway/auth/oidc/callback": "Needs a live OIDC identity provider; the harness signs in with a password.",
    "GET /gateway/auth/oidc/login": "Needs a live OIDC identity provider; the harness signs in with a password.",
    "GET /gateway/auth/workos/callback": "Signs an organization admin in to their linked organization's WorkOS account, which needs a WorkOS environment, an AuthKit application and a browser round trip; no stack the harness builds has one. Covered by core's test_workos_sign_in_routes.py against real Postgres with WorkOS answered in process.",
    "GET /gateway/auth/workos/organization": "Signs an organization admin in to their linked organization's WorkOS account, which needs a WorkOS environment, an AuthKit application and a browser round trip; no stack the harness builds has one. Covered by core's test_workos_sign_in_routes.py against real Postgres with WorkOS answered in process.",
    "GET /gateway/chats/archived": "Switch Console archived chats. Covered by core's test_chats_routes.py against real Postgres; no scenario drives Console chats yet (every other /gateway/chats route is still in the backlog).",
    "GET /gateway/chats/agent-candidates": "Switch Console group chats. Covered by core's test_chats_groups.py against real Postgres; no scenario drives Console chats yet (every other /gateway/chats route is still in the backlog), and the stacks the harness builds do not turn on the group_chats flag these routes need.",
    "GET /gateway/chats/{room_id}/commands": "The commands the chat composer offers on `!`. Covered by core's test_chats_controls.py against real Postgres; no scenario drives Console chats yet, and the stacks the harness builds do not turn on the group_chats flag.",
    "GET /gateway/chats/{room_id}/threads/{root_id}/messages": "Switch Console group chats. Covered by core's test_chats_groups.py against real Postgres; no scenario drives Console chats yet (every other /gateway/chats route is still in the backlog), and the stacks the harness builds do not turn on the group_chats flag these routes need.",
    "GET /gateway/docs": "FastAPI's generated API documentation; no behaviour of Switch's own to cover.",
    "GET /gateway/docs/oauth2-redirect": "FastAPI's generated API documentation; no behaviour of Switch's own to cover.",
    "GET /gateway/hosted-controller/machines": "Needs a hosted controller configured (HOSTED_CONTROLLER_CONFIG_PATH), which no stack the harness builds has.",
    "GET /gateway/openapi.json": "FastAPI's generated API documentation; no behaviour of Switch's own to cover.",
    "GET /gateway/organizations/current/connector-apps": "An organization's own connector apps, behind the organization_connector_apps flag (off by default), which no stack the harness builds turns on; saving or checking one also needs a real vendor app. Covered by core's test_organization_connector_apps.py against real Postgres.",
    "GET /gateway/organizations/current/connector-apps/{service}/impact": "An organization's own connector apps, behind the organization_connector_apps flag (off by default), which no stack the harness builds turns on; saving or checking one also needs a real vendor app. Covered by core's test_organization_connector_apps.py against real Postgres.",
    "GET /gateway/organizations/current/services": "An organization's service switches, behind the organization_connector_apps flag (off by default), which no stack the harness builds turns on. Covered by core's test_organization_services.py against real Postgres.",
    "GET /gateway/provider-connections/github/authorize": "Needs a registered GitHub App and a browser round trip through github.com.",
    "GET /gateway/provider-connections/github/callback": "Needs a registered GitHub App and a browser round trip through github.com.",
    "GET /gateway/redoc": "FastAPI's generated API documentation; no behaviour of Switch's own to cover.",
    "GET /gateway/service-connections/{service}/flows/authorize": "Needs the third-party service's own sign-in page in a browser.",
    "GET /gateway/service-connections/{service}/flows/callback": "Needs the third-party service's own sign-in page in a browser.",
    "PATCH /gateway/auth/me": "Changing your own display name. Covered by core's test_update_me.py against real Postgres; no scenario changes a signed-in user's profile yet.",
    "POST /gateway/auth/oidc/exchange": "Needs a code from a live OIDC sign-in; the harness signs in with a password.",
    "POST /gateway/chats/{room_id}/agents": "Switch Console group chats. Covered by core's test_chats_groups.py against real Postgres; no scenario drives Console chats yet (every other /gateway/chats route is still in the backlog), and the stacks the harness builds do not turn on the group_chats flag these routes need.",
    "POST /gateway/chats/{room_id}/unarchive": "Switch Console archived chats. Covered by core's test_chats_routes.py against real Postgres; no scenario drives Console chats yet (every other /gateway/chats route is still in the backlog).",
    "POST /gateway/collaborations/{bridge_id}/identities/require-confirmation": "Demotes every older link on a bridge at once, so a scenario running on a shared stack (dev, staging) would demote every real person's link there. Core's test_identity_link_confirmation.py covers it against real Postgres; the agent-identity scenario covers the list it acts on.",
    "POST /gateway/collaborations/{bridge_id}/identities/{external_user_row_id}/verify-session": "Used only by the bundled deployment's setup job, against the Mattermost account it seeds, before any channel has an agent to hear a code. Every bundled install runs it; core's test_identity_link_confirmation.py and test_setup_link_owner.py cover it.",
    "POST /gateway/hosted-controller/machines/{machine_id}/observation": "Needs a hosted controller configured (HOSTED_CONTROLLER_CONFIG_PATH), which no stack the harness builds has.",
    "POST /gateway/hosted-controller/machines/{machine_id}/prepare": "Needs a hosted controller configured (HOSTED_CONTROLLER_CONFIG_PATH), which no stack the harness builds has.",
    "POST /gateway/organizations/current/connector-apps/{service}/check": "An organization's own connector apps, behind the organization_connector_apps flag (off by default), which no stack the harness builds turns on; saving or checking one also needs a real vendor app. Covered by core's test_organization_connector_apps.py against real Postgres.",
    "POST /gateway/rooms/{room_id}/sync-name": "Needs a bridged room whose linked channel was renamed on the platform, which the fast lane's stacks cannot stage. Covered by core's test_room_sync_name.py against real Postgres.",
    "PUT /gateway/chats/{room_id}/read": "Switch Console read positions. Covered by core's test_chats_groups.py against real Postgres; no scenario drives Console chats yet (every other /gateway/chats route is still in the backlog).",
    "PUT /gateway/organizations/current/connector-apps/{service}": "An organization's own connector apps, behind the organization_connector_apps flag (off by default), which no stack the harness builds turns on; saving or checking one also needs a real vendor app. Covered by core's test_organization_connector_apps.py against real Postgres.",
    "PUT /gateway/organizations/current/services/{service}": "An organization's service switches, behind the organization_connector_apps flag (off by default), which no stack the harness builds turns on. Covered by core's test_organization_services.py against real Postgres.",
    "WS /gateway/changes/ws": "Console's change-notice socket. What it sends is covered by core's test_changes_socket.py, and the session probe checks it refuses a handshake without a session; no scenario drives Console's lists yet.",
    "get_template_status": "Needs an agent created from an official template on a managed machine and then a newer revision of that template; no stack the harness builds has managed agents yet (create_agent is in the backlog). Covered by core's test_template_updates.py.",
    "invite_agent_to_room": "Its interesting answer is the refusal, and an agent is refused only when its owner is neither an admin nor the room's owner. Every harness agent and room belongs to the harness admin, and a second, plain user to own the agent cannot be deleted afterwards, which rules it out on local, dev and staging. Who may change a room's roster is covered by core's test_room_roster_authz.py, and the 403 with its detail by test_refusal_status_codes.py."
  },
  "unauthenticated": {
    "GET /gateway/agents/known-types": "The catalogue of agent types this server can register and their option schemas; no tenant data. Public since the initial import, and nothing records whether that is deliberate.",
    "GET /gateway/auth/config": "Read by the login page before any session exists, to choose which sign-in methods to offer.",
    "GET /gateway/auth/oidc/callback": "The OIDC sign-in round trip, before any session exists.",
    "GET /gateway/auth/oidc/login": "The OIDC sign-in round trip, before any session exists.",
    "GET /gateway/docs": "FastAPI's generated docs, served without a session. They publish the gateway's whole route list and schemas to anyone who can reach it.",
    "GET /gateway/docs/oauth2-redirect": "FastAPI's generated docs, served without a session. They publish the gateway's whole route list and schemas to anyone who can reach it.",
    "GET /gateway/openapi.json": "FastAPI's generated docs, served without a session. They publish the gateway's whole route list and schemas to anyone who can reach it.",
    "GET /gateway/provider-connections/github/authorize": "The GitHub App's redirect round trip: the sign-in flow is identified by its state parameter, not a session.",
    "GET /gateway/provider-connections/github/callback": "The GitHub App's redirect round trip: the sign-in flow is identified by its state parameter, not a session.",
    "GET /gateway/redoc": "FastAPI's generated docs, served without a session. They publish the gateway's whole route list and schemas to anyone who can reach it.",
    "GET /gateway/service-connections/{service}/flows/authorize": "The third-party sign-in round trip: the flow is identified by its state, not a session.",
    "GET /gateway/service-connections/{service}/flows/callback": "The third-party sign-in round trip: the flow is identified by its state, not a session.",
    "POST /gateway/auth/login": "How a session is obtained.",
    "POST /gateway/auth/logout": "Only clears the session cookie; there is nothing behind it to protect.",
    "POST /gateway/auth/oidc/exchange": "Trades a code from an OIDC sign-in for a session, so it runs before one exists; the code is good only with the PKCE verifier its challenge was made from, and only while fresh.",
    "POST /gateway/auth/signup": "How an account, and its first session, is created."
  },
  "backlog": [
    "add_users_to_room",
    "archive_room",
    "assume_role",
    "attach_reference_to_room",
    "create_agent",
    "create_reference",
    "create_room_document",
    "create_room_from_yaml",
    "define_role",
    "delete_role",
    "delete_room_document",
    "delete_template",
    "edit_role",
    "get_advanced_config",
    "get_agent_detail",
    "get_my_context",
    "get_role_detail",
    "get_template",
    "get_template_guide",
    "link_rooms",
    "list_agents",
    "list_all_references",
    "list_all_rooms",
    "list_bridges",
    "list_linked_rooms",
    "list_machines",
    "list_managed_agents",
    "list_participants",
    "list_reference_types",
    "list_references",
    "list_roles",
    "list_room_groups",
    "list_templates",
    "load_internal_documents",
    "release_role",
    "remove_agent_from_room",
    "remove_agent_service",
    "request_agent_deletion",
    "run_template",
    "save_template",
    "send_targeted_message",
    "set_agent_service",
    "unarchive_room",
    "unlink_rooms",
    "update_agent_detail",
    "update_room",
    "update_room_document",
    "update_template",
    "DELETE /gateway/agents/by-name/{agent_name}",
    "DELETE /gateway/agents/{agent_id}",
    "DELETE /gateway/agents/{agent_id}/service-grants/{service}",
    "DELETE /gateway/api-keys/{key_id}",
    "DELETE /gateway/auth/me",
    "DELETE /gateway/chats/{room_id}/hidden",
    "DELETE /gateway/chats/{room_id}/members/{member_user_id}",
    "DELETE /gateway/collaborations/{bridge_id}",
    "DELETE /gateway/collaborations/{bridge_id}/teams/{team_id}",
    "DELETE /gateway/connector-apps/{service}",
    "DELETE /gateway/documents/{document_id}",
    "DELETE /gateway/management/agents/{agent_id}",
    "DELETE /gateway/management/controllers/{controller_id}",
    "DELETE /gateway/management/controllers/{controller_id}/provider-logins/{provider}",
    "DELETE /gateway/messaging-apps/installs/{install_id}",
    "DELETE /gateway/packages/{package_id}/documents/{document_id}",
    "DELETE /gateway/packages/{package_id}/references/{reference_id}",
    "DELETE /gateway/provider-connections/github",
    "DELETE /gateway/provider-connections/github/flows/{flow_id}",
    "DELETE /gateway/references/reference-types/{type}",
    "DELETE /gateway/references/{reference_id}",
    "DELETE /gateway/rooms/{room_id}",
    "DELETE /gateway/rooms/{room_id}/agents/{agent_id}",
    "DELETE /gateway/rooms/{room_id}/documents/{document_id}",
    "DELETE /gateway/rooms/{room_id}/linked-rooms/{target_room_id}",
    "DELETE /gateway/rooms/{room_id}/packages/{package_id}",
    "DELETE /gateway/rooms/{room_id}/references/{reference_id}",
    "DELETE /gateway/rooms/{room_id}/roles/{name}",
    "DELETE /gateway/service-connections/{service}",
    "DELETE /gateway/service-connections/{service}/flows/{flow_id}",
    "DELETE /gateway/templates/{template_id}",
    "DELETE /gateway/tenants/{tenant_id}/budgets/{budget_id}",
    "DELETE /gateway/tenants/{tenant_id}/invitations/{invitation_id}",
    "DELETE /gateway/tenants/{tenant_id}/join-domains/{domain}",
    "DELETE /gateway/trust-settings",
    "GET /gateway/agent-sessions/approvals",
    "GET /gateway/agents/avatar-settings",
    "GET /gateway/agents/icon-choices",
    "GET /gateway/agents/known-types",
    "GET /gateway/agents/{agent_id}",
    "GET /gateway/agents/{agent_id}/service-grants",
    "GET /gateway/api-keys",
    "GET /gateway/api-keys/{key_id}/reveal",
    "GET /gateway/auth/me",
    "GET /gateway/auth/me/identities",
    "GET /gateway/chats",
    "GET /gateway/chats/activity/events",
    "GET /gateway/chats/events",
    "GET /gateway/chats/{room_id}/activity",
    "GET /gateway/chats/{room_id}/media",
    "GET /gateway/chats/{room_id}/members",
    "GET /gateway/chats/{room_id}/messages",
    "GET /gateway/collaborations",
    "GET /gateway/collaborations/setup/slack",
    "GET /gateway/collaborations/types",
    "GET /gateway/collaborations/{bridge_id}/directory",
    "GET /gateway/collaborations/{bridge_id}/teams",
    "GET /gateway/collaborations/{bridge_id}/teams-package",
    "GET /gateway/collaborations/{bridge_id}/users",
    "GET /gateway/connector-apps",
    "GET /gateway/connector-apps/{service}/impact",
    "GET /gateway/documents",
    "GET /gateway/documents/{document_id}",
    "GET /gateway/documents/{document_id}/rooms",
    "GET /gateway/ecosystem/graph",
    "GET /gateway/feature-flags",
    "GET /gateway/hosted-machines",
    "GET /gateway/hosted-machines/{machine_id}",
    "GET /gateway/invitations/mine",
    "GET /gateway/joinable-tenants",
    "GET /gateway/linked-rooms/graph",
    "GET /gateway/management/advanced-config",
    "GET /gateway/management/agents",
    "GET /gateway/management/agents/{agent_id}",
    "GET /gateway/management/controllers",
    "GET /gateway/management/controllers/{controller_id}/provider-logins",
    "GET /gateway/management/operations",
    "GET /gateway/management/providers",
    "GET /gateway/messaging-apps",
    "GET /gateway/messaging-apps/installs",
    "GET /gateway/packages",
    "GET /gateway/packages/{package_id}",
    "GET /gateway/packages/{package_id}/documents",
    "GET /gateway/packages/{package_id}/references",
    "GET /gateway/packages/{package_id}/rooms",
    "GET /gateway/provider-connections/catalog",
    "GET /gateway/provider-connections/github",
    "GET /gateway/provider-connections/github/flows/{flow_id}",
    "GET /gateway/references",
    "GET /gateway/references/reference-types",
    "GET /gateway/references/reference-types/owned",
    "GET /gateway/references/{reference_id}",
    "GET /gateway/references/{reference_id}/rooms",
    "GET /gateway/room-groups",
    "GET /gateway/rooms/template-schema",
    "GET /gateway/rooms/{room_id}/documents",
    "GET /gateway/rooms/{room_id}/documents/{document_id}",
    "GET /gateway/rooms/{room_id}/linked-rooms",
    "GET /gateway/rooms/{room_id}/linked-rooms/inbound",
    "GET /gateway/rooms/{room_id}/references",
    "GET /gateway/rooms/{room_id}/roles",
    "GET /gateway/service-connections",
    "GET /gateway/service-connections/{service}/agents",
    "GET /gateway/service-connections/{service}/flows/{flow_id}",
    "GET /gateway/template-runs",
    "GET /gateway/templates",
    "GET /gateway/templates/{template_id}",
    "GET /gateway/templates/{template_id}/content",
    "GET /gateway/tenants",
    "GET /gateway/tenants/current",
    "GET /gateway/tenants/{tenant_id}/audit-events",
    "GET /gateway/tenants/{tenant_id}/budgets",
    "GET /gateway/tenants/{tenant_id}/invitations",
    "GET /gateway/tenants/{tenant_id}/join-domains",
    "GET /gateway/tenants/{tenant_id}/usage",
    "GET /gateway/trust-settings",
    "GET /gateway/users",
    "GET /gateway/version",
    "GET /gateway/workspace/services",
    "PATCH /gateway/agents/{agent_id}/options",
    "PATCH /gateway/collaborations/{bridge_id}",
    "PATCH /gateway/documents/{document_id}",
    "PATCH /gateway/management/agents/{agent_id}",
    "PATCH /gateway/management/controllers/{controller_id}",
    "PATCH /gateway/packages/{package_id}",
    "PATCH /gateway/references/reference-types/{type}",
    "PATCH /gateway/references/{reference_id}",
    "PATCH /gateway/room-groups/{group_id}",
    "PATCH /gateway/rooms/{room_id}",
    "PATCH /gateway/rooms/{room_id}/agents/{agent_id}",
    "PATCH /gateway/rooms/{room_id}/roles/{name}",
    "PATCH /gateway/templates/{template_id}",
    "PATCH /gateway/tenants/{tenant_id}/members/{user_id}",
    "POST /gateway/agent-sessions/{agent_id}/{session_id}/approvals/{request_id}/answer",
    "POST /gateway/agents/register",
    "POST /gateway/agents/register-known-bulk",
    "POST /gateway/agents/register-other",
    "POST /gateway/api-keys",
    "POST /gateway/auth/refresh",
    "POST /gateway/auth/signup",
    "POST /gateway/chats/{room_id}/archive",
    "POST /gateway/chats/{room_id}/attachments",
    "POST /gateway/chats/{room_id}/controls",
    "POST /gateway/chats/{room_id}/members",
    "POST /gateway/chats/{room_id}/warm",
    "POST /gateway/collaborations",
    "POST /gateway/collaborations/setup/slack/check",
    "POST /gateway/collaborations/{bridge_id}/default",
    "POST /gateway/collaborations/{bridge_id}/teams/{team_id}",
    "POST /gateway/connector-apps/{service}/check",
    "POST /gateway/connector-apps/{service}/import",
    "POST /gateway/documents",
    "POST /gateway/hosted-machines/ensure",
    "POST /gateway/hosted-machines/{machine_id}/lifecycle",
    "POST /gateway/invitations/accept",
    "POST /gateway/invitations/mine/accept",
    "POST /gateway/joinable-tenants/{tenant_id}/join",
    "POST /gateway/management/agents",
    "POST /gateway/management/controllers",
    "POST /gateway/management/enrollment-codes",
    "POST /gateway/management/operations",
    "POST /gateway/messaging-apps/{platform}/claim",
    "POST /gateway/messaging-apps/{platform}/install",
    "POST /gateway/packages/{package_id}/documents/{document_id}",
    "POST /gateway/packages/{package_id}/references/{reference_id}",
    "POST /gateway/provider-connections/github/flows",
    "POST /gateway/provider-connections/github/flows/{flow_id}/complete",
    "POST /gateway/references",
    "POST /gateway/references/reference-types",
    "POST /gateway/room-groups",
    "POST /gateway/rooms/bulk-archive",
    "POST /gateway/rooms/bulk-delete",
    "POST /gateway/rooms/from-template",
    "POST /gateway/rooms/{room_id}/agents",
    "POST /gateway/rooms/{room_id}/archive",
    "POST /gateway/rooms/{room_id}/documents/{document_id}",
    "POST /gateway/rooms/{room_id}/linked-rooms",
    "POST /gateway/rooms/{room_id}/packages/{package_id}",
    "POST /gateway/rooms/{room_id}/references/{reference_id}",
    "POST /gateway/rooms/{room_id}/roles",
    "POST /gateway/rooms/{room_id}/unarchive",
    "POST /gateway/rooms/{room_id}/users",
    "POST /gateway/service-connections/{service}/flows",
    "POST /gateway/service-connections/{service}/flows/{flow_id}/complete",
    "POST /gateway/template-runs/{root_room_id}/continue",
    "POST /gateway/template-runs/{root_room_id}/stop",
    "POST /gateway/templates",
    "POST /gateway/templates/validate",
    "POST /gateway/tenants",
    "POST /gateway/tenants/{tenant_id}/budgets",
    "POST /gateway/tenants/{tenant_id}/invitations",
    "POST /gateway/tenants/{tenant_id}/join-domains",
    "POST /gateway/tenants/{tenant_id}/switch",
    "POST /gateway/users",
    "PUT /gateway/agents/{agent_id}/can-manage-agents",
    "PUT /gateway/agents/{agent_id}/description",
    "PUT /gateway/agents/{agent_id}/display-name",
    "PUT /gateway/agents/{agent_id}/icon",
    "PUT /gateway/agents/{agent_id}/service-grants/{service}",
    "PUT /gateway/auth/me/password",
    "PUT /gateway/chats/{room_id}/hidden",
    "PUT /gateway/connector-apps/{service}",
    "PUT /gateway/management/agents/{agent_id}",
    "PUT /gateway/management/controllers/{controller_id}/provider-logins/{provider}",
    "PUT /gateway/room-groups/{group_id}/rooms",
    "PUT /gateway/rooms/{room_id}/group",
    "PUT /gateway/rooms/{room_id}/observe",
    "PUT /gateway/rooms/{room_id}/protection",
    "PUT /gateway/service-connections/{service}/key",
    "PUT /gateway/tenants/{tenant_id}/budgets/{budget_id}",
    "PUT /gateway/trust-settings",
    "PUT /gateway/workspace/services/{service}"
  ]
}