onyx/web/src/lib/swr-keys.ts at main · jamilahmadzai/onyx

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

/**

* Centralized SWR cache key registry.

* All useSWR calls and mutate() calls should reference these constants

* instead of inline strings to prevent typos and make key usage greppable.

* For dynamic keys (e.g. per-ID endpoints), use the builder functions.

export const SWR_KEYS = {

// ── User ──────────────────────────────────────────────────────────────────

me: "/api/me",

// ── Health / Version ──────────────────────────────────────────────────────

health: "/api/health",

version: "/api/version",

// ── Settings ──────────────────────────────────────────────────────────────

settings: "/api/settings",

enterpriseSettings: "/api/enterprise-settings",

customAnalyticsScript: "/api/enterprise-settings/custom-analytics-script",

authType: "/api/auth/type",

// ── Agents / Personas ─────────────────────────────────────────────────────

personas: "/api/persona",

persona: (id: number) => `/api/persona/${id}`,

agentPreferences: "/api/user/assistant/preferences",

defaultAssistantConfig: "/api/admin/default-assistant/configuration",

personaLabels: "/api/persona/labels",

adminAgents: "/api/admin/agents",

adminPersona: "/api/admin/persona",

// ── LLM Providers ─────────────────────────────────────────────────────────

llmProviders: "/api/llm/provider",

llmProvidersForPersona: (personaId: number) =>

`/api/llm/persona/${personaId}/providers`,

adminLlmProviders: "/api/admin/llm/provider",

llmProvidersWithImageGen: "/api/admin/llm/provider?include_image_gen=true",

customProviderNames: "/api/admin/llm/custom-provider-names",

wellKnownLlmProviders: "/api/admin/llm/built-in/options",

wellKnownLlmProvider: (providerEndpoint: string) =>

`/api/admin/llm/built-in/options/${providerEndpoint}`,

llmContextualCost: "/api/admin/llm/provider-contextual-cost",

// ── Image Generation ──────────────────────────────────────────────────────

imageGenConfig: "/api/admin/image-generation/config",

// ── Documents ─────────────────────────────────────────────────────────────

documentSets: "/api/manage/document-set",

documentSetsEditable: "/api/manage/document-set?get_editable=true",

tags: "/api/query/valid-tags",

connectorStatus: "/api/manage/connector-status",

// ── Credentials & Connectors ──────────────────────────────────────────────

adminCredentials: "/api/manage/admin/credential",

indexingStatus: "/api/manage/admin/connector/indexing-status",

adminConnectorStatus: "/api/manage/admin/connector/status",

federatedConnectors: "/api/federated",

// ── Google Connectors ─────────────────────────────────────────────────────

googleConnectorAppCredential: (service: "gmail" | "google-drive") =>

`/api/manage/admin/connector/${service}/app-credential`,

googleConnectorServiceAccountKey: (service: "gmail" | "google-drive") =>

`/api/manage/admin/connector/${service}/service-account-key`,

googleConnectorCredentials: (service: "gmail" | "google-drive") =>

`/api/manage/admin/connector/${service}/credentials`,

googleConnectorPublicCredential: (service: "gmail" | "google-drive") =>

`/api/manage/admin/connector/${service}/public-credential`,

googleConnectorServiceAccountCredential: (

service: "gmail" | "google-drive"

) => `/api/manage/admin/connector/${service}/service-account-credential`,

// ── Search Settings ───────────────────────────────────────────────────────

currentSearchSettings: "/api/search-settings/get-current-search-settings",

secondarySearchSettings: "/api/search-settings/get-secondary-search-settings",

embeddingProviders: "/api/admin/embedding/embedding-provider",

// ── Chat Sessions ─────────────────────────────────────────────────────────

chatSessions: "/api/chat/get-user-chat-sessions",

// ── Projects & Files ──────────────────────────────────────────────────────

userProjects: "/api/user/projects",

recentFiles: "/api/user/files/recent",

userPats: "/api/user/pats",

notifications: "/api/notifications",

// ── Users ─────────────────────────────────────────────────────────────────

acceptedUsers: "/api/manage/users/accepted/all",

invitedUsers: "/api/manage/users/invited",

// Curator-accessible listing of all users (and optionally service-account

// entries when `?include_api_keys=true`). Used by group create/edit pages so

// global curators — who cannot hit the admin-only `/accepted/all` and

// `/invited` endpoints — can still load the member picker.

groupMemberCandidates: "/api/manage/users?include_api_keys=true",

pendingTenantUsers: "/api/tenants/users/pending",

userCounts: "/api/manage/users/counts",

// ── API Keys ──────────────────────────────────────────────────────────────

adminApiKeys: "/api/admin/api-key",

// ── Groups ────────────────────────────────────────────────────────────────

adminUserGroups: "/api/manage/admin/user-group",

shareableGroups: "/api/manage/user-groups/minimal",

scimToken: "/api/admin/enterprise-settings/scim/token",

// ── MCP Servers ───────────────────────────────────────────────────────────

adminMcpServers: "/api/admin/mcp/servers",

mcpServers: "/api/mcp/servers",

// ── Skills ────────────────────────────────────────────────────────────────

adminSkills: "/api/admin/skills",

userSkills: "/api/skills",

// ── Tools ─────────────────────────────────────────────────────────────────

tools: "/api/tool",

openApiTools: "/api/tool/openapi",

oauthTokenStatus: "/api/user-oauth-token/status",

// ── Voice ─────────────────────────────────────────────────────────────────

voiceProviders: "/api/admin/voice/providers",

voiceStatus: "/api/voice/status",

// ── Build (Craft) ─────────────────────────────────────────────────────────

buildUserLibraryTree: "/api/build/user-library/tree",

buildSessionFiles: (sessionId: string) =>

`/api/build/sessions/${sessionId}/files?path=`,

buildSessionOutputFiles: (sessionId: string) =>

`/api/build/sessions/${sessionId}/files?path=outputs`,

buildSessionWebappInfo: (sessionId: string) =>

`/api/build/sessions/${sessionId}/webapp-info`,

buildSessionArtifacts: (sessionId: string) =>

`/api/build/sessions/${sessionId}/artifacts`,

buildSessionArtifactFile: (sessionId: string, filePath: string) =>

`/api/build/sessions/${sessionId}/artifacts/${filePath}`,

buildSessionPptxPreview: (sessionId: string, filePath: string) =>

`/api/build/sessions/${sessionId}/pptx-preview/${filePath}`,

buildExternalApps: "/api/build/apps",

buildExternalAppsAdmin: "/api/build/admin/apps",

buildExternalAppsBuiltInOptions: "/api/build/admin/apps/built-in/options",

// ── Token Rate Limits ─────────────────────────────────────────────────────

globalTokenRateLimits: "/api/admin/token-rate-limits/global",

userTokenRateLimits: "/api/admin/token-rate-limits/users",

userGroupTokenRateLimits: "/api/admin/token-rate-limits/user-groups",

userGroupTokenRateLimit: (groupId: number) =>

`/api/admin/token-rate-limits/user-group/${groupId}`,

// ── Usage Reports ─────────────────────────────────────────────────────────

usageReport: "/api/admin/usage-report",

// ── Web Search ────────────────────────────────────────────────────────────

webSearchContentProviders: "/api/admin/web-search/content-providers",

webSearchSearchProviders: "/api/admin/web-search/search-providers",

// ── Prompt shortcuts ──────────────────────────────────────────────────────

promptShortcuts: "/api/input_prompt",

// ── License & Billing ─────────────────────────────────────────────────────

license: "/api/license",

billingInformationCloud: "/api/tenants/billing-information",

billingInformationSelfHosted: "/api/admin/billing/billing-information",

// ── Admin ─────────────────────────────────────────────────────────────────

hooks: "/api/admin/hooks",

hookSpecs: "/api/admin/hooks/specs",

// ── Slack Bots ────────────────────────────────────────────────────────────

slackChannels: "/api/manage/admin/slack-app/channel",

slackBots: "/api/manage/admin/slack-app/bots",

slackBot: (botId: number) => `/api/manage/admin/slack-app/bots/${botId}`,

slackBotConfig: (botId: number) =>

`/api/manage/admin/slack-app/bots/${botId}/config`,

// ── Standard Answers (EE) ─────────────────────────────────────────────────

standardAnswerCategories: "/api/manage/admin/standard-answer/category",

standardAnswers: "/api/manage/admin/standard-answer",

// ── Query History (EE) ────────────────────────────────────────────────────

adminChatSessionHistory: "/api/admin/chat-session-history",

adminChatSession: (id: string) => `/api/admin/chat-session-history/${id}`,

// ── MCP Server (per-ID) ───────────────────────────────────────────────────

adminMcpServer: (id: number) => `/api/admin/mcp/servers/${id}`,

// ── Document Processing ───────────────────────────────────────────────────

unstructuredApiKeySet: "/ 5ABC api/search-settings/unstructured-api-key-set",

// ── Connectors ────────────────────────────────────────────────────────────

connector: "/api/manage/connector",

// ── Index Attempts ────────────────────────────────────────────────────────

indexAttemptStageMetrics: (indexAttemptId: number) =>

`/api/manage/admin/index-attempt/${indexAttemptId}/stage-metrics`,

// ── CC-Pair Sync Attempts ─────────────────────────────────────────────────

// The `*Probe` variants are single-row reads used to surface the

// `applicable` flag without paying for a full page; see

// `useSyncAttemptsPaginatedFetch`.

ccPairPermissionSyncAttempts: (ccPairId: number) =>

`/api/manage/admin/cc-pair/${ccPairId}/permission-sync-attempts`,

ccPairPermissionSyncAttemptsProbe: (ccPairId: number) =>

`/api/manage/admin/cc-pair/${ccPairId}/permission-sync-attempts?page_num=0&page_size=1`,

ccPairExternalGroupSyncAttempts: (ccPairId: number) =>

`/api/manage/admin/cc-pair/${ccPairId}/external-group-sync-attempts`,

ccPairExternalGroupSyncAttemptsProbe: (ccPairId: number) =>

`/api/manage/admin/cc-pair/${ccPairId}/external-group-sync-attempts?page_num=0&page_size=1`,

// ── Indexing Errors ───────────────────────────────────────────────────────

// Base key for the per-cc-pair errors endpoint. The page also reads

// paginated variants via `usePaginatedFetch`, but `mutate` against

// this base key invalidates every variant under the same prefix.

ccPairIndexingErrors: (ccPairId: number) =>

`/api/manage/admin/cc-pair/${ccPairId}/errors`,

// ── Scheduled Tasks (Craft) ───────────────────────────────────────────────

// `scheduledTaskRuns` is a base URL — the run-history table appends

// `?limit=…` / `?cursor=…` for pagination. Invalidate from elsewhere with

// a prefix predicate so every paginated variant gets refreshed at once.

scheduledTasks: "/api/build/scheduled-tasks",

scheduledTask: (taskId: string) => `/api/build/scheduled-tasks/${taskId}`,

scheduledTaskRuns: (taskId: string) =>

`/api/build/scheduled-tasks/${taskId}/runs`,

scheduledRunContext: (sessionId: string) =>

`/api/build/sessions/${sessionId}/scheduled-run-context`,

} as const;

FilesExpand file tree

swr-keys.ts

Latest commit

History

swr-keys.ts

File metadata and controls