@thinkai/tai-api-contract 2.94.0 → 2.95.0

package/openapi/openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ThinkAI API
-  version: 2.94.0
+  version: 2.95.0
   description: >
     Contract surface for the AI Driven SDLC backend used by ThinkAI.
     Workspace-scoped routes use `/workspaces/{workspaceId}/...`.
@@ -1733,6 +1733,80 @@ paths:
         "404":
           description: Workspace does not exist or malformed workspaceId
 
+  /workspaces/{workspaceId}/integrations/sonarqube/repo-mappings:
+    get:
+      tags: [Workspace]
+      summary: List SonarQube repo to project key mappings
+      operationId: listSonarQubeRepoMappings
+      parameters:
+        - $ref: "#/components/parameters/WorkspaceId"
+      responses:
+        "200":
+          description: Mappings for repos in this workspace
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SonarQubeRepoMappingsListDto"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+    put:
+      tags: [Workspace]
+      summary: Replace SonarQube repo mappings (full list)
+      description: >
+        Replaces all SonarQube repo→projectKey rows for the workspace. Validate rows in the UI
+        before save; optional `POST .../validate` probes keys with the workspace token.
+      operationId: putSonarQubeRepoMappings
+      parameters:
+        - $ref: "#/components/parameters/WorkspaceId"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SonarQubeRepoMappingsPutDto"
+      responses:
+        "200":
+          description: Mappings saved
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SonarQubeRepoMappingsListDto"
+        "400":
+          description: Unknown repo slug or invalid body
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+
+  /workspaces/{workspaceId}/integrations/sonarqube/repo-mappings/validate:
+    post:
+      tags: [Workspace]
+      summary: Validate SonarQube mapping rows against the workspace token
+      operationId: validateSonarQubeRepoMappings
+      parameters:
+        - $ref: "#/components/parameters/WorkspaceId"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SonarQubeRepoMappingsPutDto"
+      responses:
+        "200":
+          description: Per-row probe results
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SonarQubeRepoMappingsValidateResponseDto"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "503":
+          description: SonarQube source not configured
+
   /workspaces/{workspaceId}/sources/{type}:
     delete:
       tags: [Workspace]
@@ -5501,14 +5575,17 @@ paths:
         (issues plus optional remediation from `criteriaDetails`).
 
         The Markdown is grouped **by readiness dimension** (catalog order). Each dimension section
-        lists matching issues sorted by severity. Issue sections include severity in the heading
-        and do not emit per-issue `Fix status` / `Fix tier` lines. Default filter is outstanding
-        issues (`open` + `pr-pending`). Optional query params narrow the set. When `includeCriteria`
-        is true (default), each issue includes a Remediation section from the matching criterion when
-        available. Timestamps use the optional `timeZone` query (IANA; default `UTC`).
+        lists matching issues sorted by severity. Issue sections include severity in the heading,
+        export format version, issue/rubric metadata, agent workflow, and agent instructions from
+        the rubric when available. Default filter is outstanding issues (`open` + `pr-pending`).
+        Optional query params narrow the set. When `includeCriteria` is true (default), each issue
+        also includes criterion summary/status in metadata and remediation from `criteriaDetails`
+        when it differs from agent instructions. Agent workflow and rubric agent instructions are
+        emitted regardless of `includeCriteria`. Timestamps use the optional `timeZone` query
+        (IANA; default `UTC`).
 
         The response sets `Content-Disposition: attachment` with filename
-        `readiness-issues-{providerSlug}-{date}.md`.
+        `readiness-remediations-{providerSlug}-{date}.md`.
       operationId: exportReadinessRepoIssuesMarkdown
       parameters:
         - $ref: "#/components/parameters/WorkspaceId"
@@ -5536,7 +5613,11 @@ paths:
         - name: includeCriteria
           in: query
           required: false
-          description: Include remediation from criteriaDetails (default true).
+          description: >
+            When true (default), include criterion summary/status in issue metadata and remediation
+            from `criteriaDetails` (plus inline scan remediation paragraphs). Agent workflow and
+            rubric agent instructions are always included. When false, omit criterion-derived metadata
+            and criterion remediation only.
           schema:
             type: boolean
             default: true
@@ -9940,9 +10021,10 @@ components:
     SonarQubeSourceDto:
       type: object
       description: >
-        SonarQube source for workspace sources PUT and connection test. Every field is
+        SonarQube source for workspace sources PUT and connection test. Credentials only —
+        per-repository Sonar project keys are configured via repo mappings. Every field is
         re-submitted on each save; `token` is never round-tripped from `GET` workspace config.
-      required: [type, baseUrl, token, projectKey]
+      required: [type, baseUrl, token]
       additionalProperties: false
       properties:
         type:
@@ -9952,7 +10034,7 @@ components:
           type: string
           minLength: 1
           maxLength: 2048
-          description: SonarQube server URL, e.g. https://sonarqube.example.com.
+          description: SonarQube server URL, e.g. https://sonarcloud.io or https://sonarqube.example.com.
         token:
           type: string
           minLength: 1
@@ -9960,22 +10042,22 @@ components:
           description: >
             User or project analysis token (write-only on PUT). Literal tokens are
             encrypted at rest. Operator-managed secrets may use an `env:VAR` reference
-            (resolved at runtime / batch poll), matching other non-AI-tool sources.
-        projectKey:
+            (resolved at runtime), matching other non-AI-tool sources.
+        organization:
           type: string
           minLength: 1
-          maxLength: 400
-          description: SonarQube project key (component key).
+          maxLength: 255
+          description: SonarCloud organization key (required for project search on SonarCloud).
         branch:
           type: string
           minLength: 1
           maxLength: 255
-          description: Optional branch name for branch-scoped measures.
+          description: Optional workspace default branch fallback for per-repo Sonar probes.
 
     SonarQubeSourceConfigDto:
       type: object
       description: Redacted SonarQube source returned by GET workspace config.
-      required: [type, hasToken, baseUrl, projectKey]
+      required: [type, hasToken, baseUrl]
       additionalProperties: false
       properties:
         type:
@@ -9985,10 +10067,88 @@ components:
           type: boolean
         baseUrl:
           type: string
+        organization:
+          type: string
+        branch:
+          type: string
+
+    SonarQubeRepoMappingDto:
+      type: object
+      required: [providerSlug, projectKey]
+      additionalProperties: false
+      properties:
+        providerSlug:
+          type: string
+          minLength: 1
+          description: Repository slug (`owner/repo`) in the workspace catalog.
+        projectKey:
+          type: string
+          minLength: 1
+          maxLength: 400
+        branch:
+          type: string
+          minLength: 1
+          maxLength: 255
+          description: Optional branch override for Sonar API calls for this repo.
+
+    SonarQubeRepoMappingRowDto:
+      allOf:
+        - $ref: "#/components/schemas/SonarQubeRepoMappingDto"
+        - type: object
+          required: [repoId, updatedAt]
+          properties:
+            repoId:
+              type: string
+              format: uuid
+            updatedAt:
+              type: string
+              format: date-time
+
+    SonarQubeRepoMappingsPutDto:
+      type: object
+      required: [mappings]
+      additionalProperties: false
+      properties:
+        mappings:
+          type: array
+          items:
+            $ref: "#/components/schemas/SonarQubeRepoMappingDto"
+
+    SonarQubeRepoMappingsListDto:
+      type: object
+      required: [mappings]
+      additionalProperties: false
+      properties:
+        mappings:
+          type: array
+          items:
+            $ref: "#/components/schemas/SonarQubeRepoMappingRowDto"
+
+    SonarQubeRepoMappingValidateRowDto:
+      type: object
+      required: [providerSlug, projectKey, ok]
+      additionalProperties: false
+      properties:
+        providerSlug:
+          type: string
         projectKey:
           type: string
         branch:
           type: string
+        ok:
+          type: boolean
+        error:
+          type: string
+
+    SonarQubeRepoMappingsValidateResponseDto:
+      type: object
+      required: [results]
+      additionalProperties: false
+      properties:
+        results:
+          type: array
+          items:
+            $ref: "#/components/schemas/SonarQubeRepoMappingValidateRowDto"
 
     PagerDutySourceDto:
       type: object

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thinkai/tai-api-contract",
-  "version": "2.94.0",
+  "version": "2.95.0",
   "private": false,
   "type": "module",
   "main": "dist/index.js",

package/src/generated/openapi.ts

@@ -606,6 +606,44 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/workspaces/{workspaceId}/integrations/sonarqube/repo-mappings": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List SonarQube repo to project key mappings */
+        get: operations["listSonarQubeRepoMappings"];
+        /**
+         * Replace SonarQube repo mappings (full list)
+         * @description Replaces all SonarQube repo→projectKey rows for the workspace. Validate rows in the UI before save; optional `POST .../validate` probes keys with the workspace token.
+         */
+        put: operations["putSonarQubeRepoMappings"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/workspaces/{workspaceId}/integrations/sonarqube/repo-mappings/validate": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Validate SonarQube mapping rows against the workspace token */
+        post: operations["validateSonarQubeRepoMappings"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/workspaces/{workspaceId}/sources/{type}": {
         parameters: {
             query?: never;
@@ -2133,8 +2171,8 @@ export interface paths {
         /**
          * Export repository readiness issues as Markdown
          * @description Download outstanding readiness issues for one repository as a Markdown (`.md`) attachment for local IDE workflows. Reuses the same scorecard as `GET .../readiness/repos/{repoId}` (issues plus optional remediation from `criteriaDetails`).
-         *     The Markdown is grouped **by readiness dimension** (catalog order). Each dimension section lists matching issues sorted by severity. Issue sections include severity in the heading and do not emit per-issue `Fix status` / `Fix tier` lines. Default filter is outstanding issues (`open` + `pr-pending`). Optional query params narrow the set. When `includeCriteria` is true (default), each issue includes a Remediation section from the matching criterion when available. Timestamps use the optional `timeZone` query (IANA; default `UTC`).
-         *     The response sets `Content-Disposition: attachment` with filename `readiness-issues-{providerSlug}-{date}.md`.
+         *     The Markdown is grouped **by readiness dimension** (catalog order). Each dimension section lists matching issues sorted by severity. Issue sections include severity in the heading, export format version, issue/rubric metadata, agent workflow, and agent instructions from the rubric when available. Default filter is outstanding issues (`open` + `pr-pending`). Optional query params narrow the set. When `includeCriteria` is true (default), each issue also includes criterion summary/status in metadata and remediation from `criteriaDetails` when it differs from agent instructions. Agent workflow and rubric agent instructions are emitted regardless of `includeCriteria`. Timestamps use the optional `timeZone` query (IANA; default `UTC`).
+         *     The response sets `Content-Disposition: attachment` with filename `readiness-remediations-{providerSlug}-{date}.md`.
          */
         get: operations["exportReadinessRepoIssuesMarkdown"];
         put?: never;
@@ -3991,17 +4029,17 @@ export interface components {
             orgId?: string;
             orgName?: string;
         };
-        /** @description SonarQube source for workspace sources PUT and connection test. Every field is re-submitted on each save; `token` is never round-tripped from `GET` workspace config. */
+        /** @description SonarQube source for workspace sources PUT and connection test. Credentials only — per-repository Sonar project keys are configured via repo mappings. Every field is re-submitted on each save; `token` is never round-tripped from `GET` workspace config. */
         SonarQubeSourceDto: {
             /** @enum {string} */
             type: "sonarqube";
-            /** @description SonarQube server URL, e.g. https://sonarqube.example.com. */
+            /** @description SonarQube server URL, e.g. https://sonarcloud.io or https://sonarqube.example.com. */
             baseUrl: string;
-            /** @description User or project analysis token (write-only on PUT). Literal tokens are encrypted at rest. Operator-managed secrets may use an `env:VAR` reference (resolved at runtime / batch poll), matching other non-AI-tool sources. */
+            /** @description User or project analysis token (write-only on PUT). Literal tokens are encrypted at rest. Operator-managed secrets may use an `env:VAR` reference (resolved at runtime), matching other non-AI-tool sources. */
             token: string;
-            /** @description SonarQube project key (component key). */
-            projectKey: string;
-            /** @description Optional branch name for branch-scoped measures. */
+            /** @description SonarCloud organization key (required for project search on SonarCloud). */
+            organization?: string;
+            /** @description Optional workspace default branch fallback for per-repo Sonar probes. */
             branch?: string;
         };
         /** @description Redacted SonarQube source returned by GET workspace config. */
@@ -4010,8 +4048,37 @@ export interface components {
             type: "sonarqube";
             hasToken: boolean;
             baseUrl: string;
+            organization?: string;
+            branch?: string;
+        };
+        SonarQubeRepoMappingDto: {
+            /** @description Repository slug (`owner/repo`) in the workspace catalog. */
+            providerSlug: string;
+            projectKey: string;
+            /** @description Optional branch override for Sonar API calls for this repo. */
+            branch?: string;
+        };
+        SonarQubeRepoMappingRowDto: components["schemas"]["SonarQubeRepoMappingDto"] & {
+            /** Format: uuid */
+            repoId: string;
+            /** Format: date-time */
+            updatedAt: string;
+        };
+        SonarQubeRepoMappingsPutDto: {
+            mappings: components["schemas"]["SonarQubeRepoMappingDto"][];
+        };
+        SonarQubeRepoMappingsListDto: {
+            mappings: components["schemas"]["SonarQubeRepoMappingRowDto"][];
+        };
+        SonarQubeRepoMappingValidateRowDto: {
+            providerSlug: string;
             projectKey: string;
             branch?: string;
+            ok: boolean;
+            error?: string;
+        };
+        SonarQubeRepoMappingsValidateResponseDto: {
+            results: components["schemas"]["SonarQubeRepoMappingValidateRowDto"][];
         };
         /** @description PagerDuty incident monitoring source for `PUT /workspaces/{workspaceId}/sources` and `POST /workspaces/{workspaceId}/sources/test`. Requires a REST API v2 token (an "API Access Key" from PagerDuty → **Integrations → API Access Keys**). */
         PagerDutySourceDto: {
@@ -8179,6 +8246,12 @@ export type GrafanaSourceDto = components['schemas']['GrafanaSourceDto'];
 export type GrafanaSourceConfigDto = components['schemas']['GrafanaSourceConfigDto'];
 export type SonarQubeSourceDto = components['schemas']['SonarQubeSourceDto'];
 export type SonarQubeSourceConfigDto = components['schemas']['SonarQubeSourceConfigDto'];
+export type SonarQubeRepoMappingDto = components['schemas']['SonarQubeRepoMappingDto'];
+export type SonarQubeRepoMappingRowDto = components['schemas']['SonarQubeRepoMappingRowDto'];
+export type SonarQubeRepoMappingsPutDto = components['schemas']['SonarQubeRepoMappingsPutDto'];
+export type SonarQubeRepoMappingsListDto = components['schemas']['SonarQubeRepoMappingsListDto'];
+export type SonarQubeRepoMappingValidateRowDto = components['schemas']['SonarQubeRepoMappingValidateRowDto'];
+export type SonarQubeRepoMappingsValidateResponseDto = components['schemas']['SonarQubeRepoMappingsValidateResponseDto'];
 export type PagerDutySourceDto = components['schemas']['PagerDutySourceDto'];
 export type PagerDutySourceConfigDto = components['schemas']['PagerDutySourceConfigDto'];
 export type AgentExecutionProviderDto = components['schemas']['AgentExecutionProviderDto'];
@@ -10239,6 +10312,100 @@ export interface operations {
             };
         };
     };
+    listSonarQubeRepoMappings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspaceId: components["parameters"]["WorkspaceId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Mappings for repos in this workspace */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SonarQubeRepoMappingsListDto"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+        };
+    };
+    putSonarQubeRepoMappings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspaceId: components["parameters"]["WorkspaceId"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SonarQubeRepoMappingsPutDto"];
+            };
+        };
+        responses: {
+            /** @description Mappings saved */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SonarQubeRepoMappingsListDto"];
+                };
+            };
+            /** @description Unknown repo slug or invalid body */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+        };
+    };
+    validateSonarQubeRepoMappings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspaceId: components["parameters"]["WorkspaceId"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SonarQubeRepoMappingsPutDto"];
+            };
+        };
+        responses: {
+            /** @description Per-row probe results */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SonarQubeRepoMappingsValidateResponseDto"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            /** @description SonarQube source not configured */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     deleteSourceByType: {
         parameters: {
             query?: never;
@@ -14126,7 +14293,7 @@ export interface operations {
                 fixStatus?: "open" | "pr-pending" | "fixed";
                 dimensionId?: components["schemas"]["ReadinessDimensionId"];
                 severity?: "critical" | "high" | "medium" | "low";
-                /** @description Include remediation from criteriaDetails (default true). */
+                /** @description When true (default), include criterion summary/status in issue metadata and remediation from `criteriaDetails` (plus inline scan remediation paragraphs). Agent workflow and rubric agent instructions are always included. When false, omit criterion-derived metadata and criterion remediation only. */
                 includeCriteria?: boolean;
                 /** @description IANA time zone for human-readable `Last analyzed` / `Exported` timestamps and the calendar date in the attachment filename (e.g. `Europe/Berlin`). Defaults to `UTC`. */
                 timeZone?: string;