@thinkai/tai-api-contract 2.11.0 → 2.12.0

package/openapi/openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ThinkAI API
-  version: 2.11.0
+  version: 2.12.0
   description: >
     Contract surface for the AI Driven SDLC backend used by ThinkAI.
     Workspace-scoped routes use `/workspaces/{workspaceId}/...`.
@@ -52,6 +52,8 @@ tags:
     description: Agentic Foundation pillars (epic #278); reads stored repository readiness snapshots
   - name: YourAiJourney
     description: Your AI Journey dashboard aggregators (epic #267); composes readiness, metrics, and AI-spend data for the /dashboard page
+  - name: WorkspaceActivity
+    description: Workspace-wide lifecycle activity log — repo add/remove/re-add and integration lifecycle events (issue #515).
   - name: PlatformAdmin
     description: Platform-admin operations restricted to PLATFORM_ADMIN_EMAILS. Callers must present a valid JWT from an email on that allowlist; all other callers receive 403.
 
@@ -2282,6 +2284,12 @@ paths:
         - $ref: "#/components/parameters/PaginationOrder"
         - $ref: "#/components/parameters/ReadinessRepoSearch"
         - $ref: "#/components/parameters/ReadinessRepoLanguage"
+        - name: includeArchived
+          in: query
+          description: When `true`, includes Inactive (user-removed) repos alongside Active ones. Default is `false` (active only).
+          schema:
+            type: boolean
+            default: false
       responses:
         "200":
           description: Paginated repositories analyzed
@@ -2306,6 +2314,43 @@ paths:
               schema:
                 $ref: "#/components/schemas/ErrorMessageDto"
 
+  /workspaces/{workspaceId}/readiness/initialize:
+    post:
+      tags: [RepositoryReadiness]
+      summary: Trigger initial readiness scans for all workspace repos (idempotent)
+      description: >
+        Called automatically when a user first visits the Agentic Foundation dashboard.
+        Enqueues readiness scans for every GitHub repo in the workspace that has not yet been
+        scanned. Idempotent — if any readiness run has ever been queued for this workspace the
+        request is a no-op and returns `already_triggered`. Safe to call on every page load;
+        the backend enforces the once-per-workspace guarantee via the database.
+      operationId: postReadinessInitialize
+      parameters:
+        - $ref: "#/components/parameters/WorkspaceId"
+      responses:
+        "200":
+          description: Already triggered in a previous session — no new runs enqueued
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ReadinessInitializeResponseDto"
+        "202":
+          description: Scans enqueued for all repos (first-time trigger)
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ReadinessInitializeResponseDto"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "501":
+          description: Feature not supported by this server build
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+
   /workspaces/{workspaceId}/readiness/analyze:
     post:
       tags: [RepositoryReadiness]
@@ -2425,6 +2470,62 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ErrorMessageDto"
+    patch:
+      tags: [RepositoryReadiness]
+      summary: Archive (remove) or restore (re-add) a repository
+      description: >
+        Set `archived: true` to soft-remove the repo (Inactive). Set `archived: false` to re-add a
+        previously Inactive repo (Active). Re-add reuses the same `repo_id` row so historical scan
+        foreign keys remain intact, and automatically enqueues a fresh readiness scan.
+
+        Returns `409` with `code: repo_scan_in_progress` if a scan is queued or running when archiving.
+        Returns `409` with `code: repo_already_active` if re-adding a repo that is already Active.
+      operationId: patchReadinessRepo
+      parameters:
+        - $ref: "#/components/parameters/WorkspaceId"
+        - $ref: "#/components/parameters/RepoId"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/PatchRepoArchiveBodyDto"
+            examples:
+              archive:
+                value:
+                  archived: true
+              restore:
+                value:
+                  archived: false
+      responses:
+        "200":
+          description: Repo status updated
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PatchRepoArchiveResponseDto"
+        "400":
+          description: Malformed request body or repoId
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "404":
+          description: Workspace or repository not found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+        "409":
+          description: Conflict — scan in progress or repo already in the requested state
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
 
   /workspaces/{workspaceId}/readiness/repos/{repoId}/runs:
     get:
@@ -2566,6 +2667,83 @@ paths:
               schema:
                 $ref: "#/components/schemas/ErrorMessageDto"
 
+  /workspaces/{workspaceId}/activity:
+    get:
+      tags: [WorkspaceActivity]
+      summary: Workspace activity log (paginated)
+      operationId: listWorkspaceActivity
+      description: >
+        Paginated, chronological feed of workspace-scoped lifecycle events: repository add/remove/re-add
+        and GitHub integration add/remove. Inactive repos remain visible in this log.
+        Filter by `eventType`, `actorUserId`, or date range (`since`/`until`).
+      parameters:
+        - $ref: "#/components/parameters/WorkspaceId"
+        - $ref: "#/components/parameters/PaginationLimit"
+        - $ref: "#/components/parameters/PaginationOffset"
+        - $ref: "#/components/parameters/PaginationOrder"
+        - name: eventType
+          in: query
+          description: Filter to a specific event type.
+          schema:
+            $ref: "#/components/schemas/ActivityLogEventTypeDto"
+        - name: actorUserId
+          in: query
+          description: Filter to events performed by a specific user (UUID).
+          schema:
+            type: string
+            format: uuid
+        - name: since
+          in: query
+          description: ISO-8601 lower bound on `occurredAt` (inclusive).
+          schema:
+            type: string
+            format: date-time
+        - name: until
+          in: query
+          description: ISO-8601 upper bound on `occurredAt` (inclusive).
+          schema:
+            type: string
+            format: date-time
+        - name: eventCategory
+          in: query
+          required: false
+          description: >
+            Filter by event namespace prefix (e.g. "fix", "repo", "integration", "readiness", "config", "member").
+          schema:
+            type: string
+        - name: search
+          in: query
+          required: false
+          description: >
+            Case-insensitive substring filter applied across repo name,
+            integration type, actor email, and actor display name.
+          schema:
+            type: string
+            maxLength: 200
+      responses:
+        "200":
+          description: Paginated activity log entries
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ActivityLogPageDto"
+        "400":
+          description: Invalid query parameters
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "404":
+          description: Workspace does not exist
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+
   /workspaces/{workspaceId}/readiness/score-history:
     get:
       tags: [RepositoryReadiness]
@@ -6080,6 +6258,22 @@ components:
         - required: [repoId]
         - required: [providerSlug]
 
+    ReadinessInitializeResponseDto:
+      type: object
+      required: [kind]
+      properties:
+        kind:
+          type: string
+          enum: [triggered, already_triggered, no_repos, no_integration]
+          description: >
+            `triggered` — scans were enqueued for the first time (HTTP 202).
+            `already_triggered` — a previous session already started scans; nothing new enqueued (HTTP 200).
+            `no_repos` — workspace has no GitHub repos connected yet (HTTP 200).
+            `no_integration` — workspace has no GitHub App installation linked yet (HTTP 200).
+        count:
+          type: integer
+          description: Number of repos enqueued. Present only when `kind` is `triggered`.
+
     ReadinessAnalyzeResponseDto:
       type: object
       required: [runId]
@@ -7310,3 +7504,148 @@ components:
                 type: integer
               activeUsers:
                 type: integer
+
+    PatchRepoArchiveBodyDto:
+      type: object
+      required: [archived]
+      properties:
+        archived:
+          type: boolean
+          description: >
+            `true` to soft-remove (Inactive). `false` to restore a previously Inactive repo (Active),
+            which also enqueues a fresh readiness scan.
+
+    PatchRepoArchiveResponseDto:
+      type: object
+      required: [repoId, status]
+      properties:
+        repoId:
+          type: string
+          format: uuid
+        status:
+          type: string
+          enum: [Active, Inactive]
+          description: Current lifecycle status of the repository after the operation.
+        runId:
+          type: string
+          format: uuid
+          nullable: true
+          description: ID of the freshly enqueued readiness scan run (only present on re-add).
+
+    ActivityLogEventTypeDto:
+      type: string
+      description: Type of workspace lifecycle event.
+      enum:
+        - repo.added
+        - repo.removed
+        - repo.readded
+        - integration.github.added
+        - integration.github.updated
+        - integration.github.removed
+        - integration.github.permissions_changed
+        - integration.github.repo_added
+        - integration.github.repo_removed
+        - fix.requested
+        - fix.generating
+        - fix.pr_created
+        - fix.merged
+        - fix.failed
+        - readiness.scan_started
+        - readiness.scan_completed
+        - readiness.scan_failed
+        - readiness.scan_partial
+        - config.cursor.added
+        - config.cursor.updated
+        - config.cursor.removed
+        - config.cursor.platform_key_enabled
+        - config.cursor.platform_key_disabled
+        - config.claude.added
+        - config.claude.updated
+        - config.claude.removed
+        - member.invited
+        - member.role_changed
+        - member.removed
+
+    ActivityLogActorDto:
+      type: object
+      required: [userId]
+      properties:
+        userId:
+          type: string
+          format: uuid
+        email:
+          type: string
+          format: email
+          nullable: true
+        name:
+          type: string
+          nullable: true
+
+    ActivityLogEntryDto:
+      type: object
+      required: [id, eventType, eventCategory, occurredAt, actorType]
+      properties:
+        id:
+          type: string
+          format: uuid
+        eventType:
+          $ref: "#/components/schemas/ActivityLogEventTypeDto"
+        eventCategory:
+          type: string
+          description: Namespace prefix derived from event_type (e.g. "fix", "repo", "config").
+        occurredAt:
+          type: string
+          format: date-time
+        actorType:
+          type: string
+          enum: [user, system, webhook]
+          description: Whether the event was triggered by a human user, a batch/system process, or a webhook.
+        actor:
+          nullable: true
+          allOf:
+            - $ref: "#/components/schemas/ActivityLogActorDto"
+        repoId:
+          type: string
+          format: uuid
+          nullable: true
+        repoName:
+          type: string
+          nullable: true
+        integrationId:
+          type: string
+          format: uuid
+          nullable: true
+        integrationType:
+          type: string
+          nullable: true
+        fixRequestId:
+          type: string
+          format: uuid
+          nullable: true
+          description: ID of the related fix request (fix.* events).
+        issueId:
+          type: string
+          format: uuid
+          nullable: true
+          description: ID of the related readiness issue (fix.* events).
+        readinessRunId:
+          type: string
+          format: uuid
+          nullable: true
+          description: ID of the related readiness run (readiness.* events).
+        metadata:
+          type: object
+          additionalProperties: true
+          nullable: true
+          description: Event-specific supplementary data (before/after state, installation IDs, etc.).
+
+    ActivityLogPageDto:
+      allOf:
+        - $ref: "#/components/schemas/PageMetaDto"
+        - type: object
+          required: [items]
+          properties:
+            items:
+              type: array
+              items:
+                $ref: "#/components/schemas/ActivityLogEntryDto"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thinkai/tai-api-contract",
-  "version": "2.11.0",
+  "version": "2.12.0",
   "private": false,
   "type": "module",
   "main": "dist/index.js",
@@ -21,6 +21,7 @@
   "dependencies": {},
   "devDependencies": {
     "@stoplight/spectral-cli": "^6.15.1",
+    "jsonpath-plus": "^10.3.0",
     "openapi-typescript": "^7.13.0",
     "typescript": "~5.3.0"
   },