chore(search): document the shared permission grant format

Author: waleedlatif1

apps/sim/connectors/gitlab/permission-config/repository.ts

@@ -172,6 +172,7 @@ export function prepareGitLabPermissions(
   }
 }
 
+/** Keeps CSV rows in the private payload and stores only the configured project’s reader grants. */
 export function gitLabPermissionData(prepared: PreparedGitLabPermissions): ConnectorPermissionData {
   const {
     revision: _revision,

apps/sim/lib/api/contracts/knowledge/connector-permissions.ts

@@ -12,6 +12,7 @@ export const connectorPermissionGrantsSchema = z.discriminatedUnion('provider',
     .pick({ provider: true, userMapping: true, projectPermissions: true })
     .required(),
 ])
+/** Provider-specific grants that an organization admin can replace without changing source settings. */
 export type ConnectorPermissionGrants = z.output<typeof connectorPermissionGrantsSchema>
 
 export const connectorPermissionSummarySchema = z.discriminatedUnion('provider', [

apps/sim/lib/knowledge/connectors/permission-store.ts

@@ -9,6 +9,7 @@ import type { DbTransaction } from '@/lib/db/types'
 
 export type ConnectorPermissionSnapshot = typeof knowledgeConnectorPermissionSnapshot.$inferSelect
 
+/** A complete replacement. Metadata can be read without loading the private payload or subject grants. */
 export interface ConnectorPermissionData {
   metadata: Record<string, unknown>
   payload: Record<string, unknown>