@thinkai/tai-api-contract 2.75.0 → 2.76.0

package/openapi/openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ThinkAI API
-  version: 2.74.0
+  version: 2.76.0
   description: >
     Contract surface for the AI Driven SDLC backend used by ThinkAI.
     Workspace-scoped routes use `/workspaces/{workspaceId}/...`.
@@ -6456,6 +6456,48 @@ paths:
               schema:
                 $ref: "#/components/schemas/GithubPermissionsCheckFailedErrorDto"
 
+  /workspaces/{workspaceId}/readiness/issues/{issueId}/fix-guide:
+    get:
+      tags: [RepositoryReadiness]
+      summary: Get scan-time fix instruction guide (G1–G5)
+      description: >
+        Returns the markdown fix guide written during the latest successful scan for this issue.
+        Applies only to platform-governance criteria **G1–G5** (`guidance` tier). **G6** and other
+        rubrics must use the Automations PR Fix it flow (`POST .../readiness/fixes`). When no guide
+        exists for a legacy run, returns `404` — re-scan the repository to generate instructions.
+      operationId: getReadinessIssueFixGuide
+      parameters:
+        - $ref: "#/components/parameters/WorkspaceId"
+        - $ref: "#/components/parameters/ReadinessIssueId"
+      responses:
+        "200":
+          description: Fix instruction guide
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ReadinessFixGuideDto"
+        "400":
+          description: Issue rubric is not G1–G5 (use PR Fix it for G6 and other criteria)
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+              examples:
+                not_guidance:
+                  value:
+                    error: "Fix guide is only available for G1–G5 governance criteria"
+                    code: fix_guide_not_guidance
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "404":
+          description: Issue not found, or no guide for the latest scan (re-scan to generate)
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+
   /workspaces/{workspaceId}/cursor/platform-key-consent:
     put:
       tags: [Integrations]
@@ -7922,6 +7964,14 @@ components:
       schema:
         type: string
         format: uuid
+    ReadinessIssueId:
+      name: issueId
+      in: path
+      required: true
+      schema:
+        type: string
+        format: uuid
+      description: Readiness issue id (`tai_workspace_repo_issues.id`).
     InsightsProductivityRangeId:
       name: rangeId
       in: query
@@ -14063,6 +14113,40 @@ components:
           type: string
           format: date-time
 
+    ReadinessFixGuideDto:
+      type: object
+      required:
+        [issueId, repoId, rubricId, sourceRunId, status, markdown, criterionTitle]
+      properties:
+        issueId:
+          type: string
+          format: uuid
+        repoId:
+          type: string
+          format: uuid
+        rubricId:
+          type: string
+          maxLength: 16
+          description: G1–G5 rubric criterion id
+        sourceRunId:
+          type: string
+          format: uuid
+          description: Readiness scan run that produced this guide
+        status:
+          type: string
+          enum: [ready, failed]
+        markdown:
+          type: string
+          description: Sanitized markdown body including server-appended Re-scan section
+        criterionTitle:
+          type: string
+          maxLength: 256
+          description: Human-readable criterion label for page chrome
+        errorDetail:
+          type: string
+          nullable: true
+          description: Present when status is failed (guide assembly error at scan time)
+
     FixRetryableErrorCode:
       type: string
       enum:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thinkai/tai-api-contract",
-  "version": "2.75.0",
+  "version": "2.76.0",
   "private": false,
   "type": "module",
   "main": "dist/index.js",
@@ -21,7 +21,7 @@
   "dependencies": {},
   "devDependencies": {
     "@stoplight/spectral-cli": "^6.16.2",
-    "@types/node": "^26.1.1",
+    "@types/node": "^26.1.2",
     "jsonpath-plus": "^10.3.0",
     "openapi-typescript": "^7.13.0",
     "typescript": "~6.0.3"

package/src/generated/openapi.ts

@@ -2467,6 +2467,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/workspaces/{workspaceId}/readiness/issues/{issueId}/fix-guide": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get scan-time fix instruction guide (G1–G5)
+         * @description Returns the markdown fix guide written during the latest successful scan for this issue. Applies only to platform-governance criteria **G1–G5** (`guidance` tier). **G6** and other rubrics must use the Automations PR Fix it flow (`POST .../readiness/fixes`). When no guide exists for a legacy run, returns `404` — re-scan the repository to generate instructions.
+         */
+        get: operations["getReadinessIssueFixGuide"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/workspaces/{workspaceId}/cursor/platform-key-consent": {
         parameters: {
             query?: never;
@@ -5936,6 +5956,27 @@ export interface components {
             /** Format: date-time */
             createdAt: string;
         };
+        ReadinessFixGuideDto: {
+            /** Format: uuid */
+            issueId: string;
+            /** Format: uuid */
+            repoId: string;
+            /** @description G1–G5 rubric criterion id */
+            rubricId: string;
+            /**
+             * Format: uuid
+             * @description Readiness scan run that produced this guide
+             */
+            sourceRunId: string;
+            /** @enum {string} */
+            status: "ready" | "failed";
+            /** @description Sanitized markdown body including server-appended Re-scan section */
+            markdown: string;
+            /** @description Human-readable criterion label for page chrome */
+            criterionTitle: string;
+            /** @description Present when status is failed (guide assembly error at scan time) */
+            errorDetail?: string | null;
+        };
         /**
          * @description Transient failure codes. Use the retrigger endpoint to start a fresh fix request. `processor_error` — unexpected internal failure; safe to retrigger after checking batch-runner logs.
          * @enum {string}
@@ -6935,6 +6976,8 @@ export interface components {
         /** @description Privacy request id (`tai_privacy_requests.id`). */
         PrivacyRequestId: string;
         FixId: string;
+        /** @description Readiness issue id (`tai_workspace_repo_issues.id`). */
+        ReadinessIssueId: string;
         /** @description Productivity insights time range. Daily windows: `7d`, `30d`, `90d`, `180d`, or custom `cr:YYYY-MM-DD:YYYY-MM-DD`. Weekly legacy: `4w`, `8w`, `q` (12 weeks), `12w`, `16w`. Omit when using explicit `from`/`to` day bounds. */
         InsightsProductivityRangeId: string;
         /** @description Inclusive start of a daily window (`YYYY-MM-DD`). When set with `to`, overrides `rangeId` for day-mode responses (max 180 days). */
@@ -7224,6 +7267,7 @@ export type ReadinessFixStatusSummaryDto = components['schemas']['ReadinessFixSt
 export type GithubInstalledRepoListDto = components['schemas']['GithubInstalledRepoListDto'];
 export type AgenticFoundationDashboardDto = components['schemas']['AgenticFoundationDashboardDto'];
 export type FixRequestDto = components['schemas']['FixRequestDto'];
+export type ReadinessFixGuideDto = components['schemas']['ReadinessFixGuideDto'];
 export type FixRetryableErrorCode = components['schemas']['FixRetryableErrorCode'];
 export type FixNonRetryableErrorCode = components['schemas']['FixNonRetryableErrorCode'];
 export type CreateFixRequestBodyDto = components['schemas']['CreateFixRequestBodyDto'];
@@ -7353,6 +7397,7 @@ export type ParameterWorkspaceMemberId = components['parameters']['WorkspaceMemb
 export type ParameterWorkspaceInvitationToken = components['parameters']['WorkspaceInvitationToken'];
 export type ParameterPrivacyRequestId = components['parameters']['PrivacyRequestId'];
 export type ParameterFixId = components['parameters']['FixId'];
+export type ParameterReadinessIssueId = components['parameters']['ReadinessIssueId'];
 export type ParameterInsightsProductivityRangeId = components['parameters']['InsightsProductivityRangeId'];
 export type ParameterInsightsProductivityFrom = components['parameters']['InsightsProductivityFrom'];
 export type ParameterInsightsProductivityTo = components['parameters']['InsightsProductivityTo'];
@@ -13906,6 +13951,50 @@ export interface operations {
             };
         };
     };
+    getReadinessIssueFixGuide: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspaceId: components["parameters"]["WorkspaceId"];
+                /** @description Readiness issue id (`tai_workspace_repo_issues.id`). */
+                issueId: components["parameters"]["ReadinessIssueId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Fix instruction guide */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ReadinessFixGuideDto"];
+                };
+            };
+            /** @description Issue rubric is not G1–G5 (use PR Fix it for G6 and other criteria) */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            /** @description Issue not found, or no guide for the latest scan (re-scan to generate) */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+        };
+    };
     putCursorPlatformKeyConsent: {
         parameters: {
             query?: never;