@thinkai/tai-api-contract 2.94.0 → 2.96.0

package/openapi/openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ThinkAI API
-  version: 2.94.0
+  version: 2.96.0
   description: >
     Contract surface for the AI Driven SDLC backend used by ThinkAI.
     Workspace-scoped routes use `/workspaces/{workspaceId}/...`.
@@ -1550,6 +1550,7 @@ paths:
                       - $ref: "#/components/schemas/GrafanaSourceDto"
                       - $ref: "#/components/schemas/SonarQubeSourceDto"
                       - $ref: "#/components/schemas/PagerDutySourceDto"
+                      - $ref: "#/components/schemas/JiraSourceDto"
                       - $ref: "#/components/schemas/TenantSourceEntryDto"
             examples:
               cursorAndJira:
@@ -1645,6 +1646,8 @@ paths:
         required; optional `branch`) calls `GET {baseUrl}/api/measures/component` with a Bearer
         token. Other types report `{ success: false, error: "unsupported_type" }`. Documented
         `error` codes for AI tool verifiers: `invalid_token`, `rate_limited`, `network_error`.
+        `jira` (`baseUrl`, `email`, `apiToken` or legacy `api_key`) calls
+        `GET {baseUrl}/rest/api/3/myself` with Basic auth.
 
         **Typical outcomes:** Malformed body, missing `type`, invalid `type`, or missing required fields for the
         declared type → `400` with `{ error: "..." }`. Well-formed body with bad credentials or unreachable
@@ -1668,6 +1671,7 @@ paths:
                 - $ref: "#/components/schemas/GrafanaSourceDto"
                 - $ref: "#/components/schemas/SonarQubeSourceDto"
                 - $ref: "#/components/schemas/PagerDutySourceDto"
+                - $ref: "#/components/schemas/JiraSourceDto"
                 - $ref: "#/components/schemas/TenantSourceEntryDto"
             examples:
               cursorValid:
@@ -1733,6 +1737,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 +5579,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 +5617,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 +10025,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 +10038,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 +10046,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 +10071,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
@@ -10041,6 +10205,73 @@ components:
           type: string
           description: PagerDuty user email when known from the last successful verify.
 
+    JiraSourceDto:
+      type: object
+      description: >
+        Jira Cloud source for `PUT /workspaces/{workspaceId}/sources` and
+        `POST /workspaces/{workspaceId}/sources/test`. Uses Atlassian Cloud email + API token
+        (Basic auth). Provide `apiToken` (preferred) or legacy write-only `api_key`; the server
+        normalizes `api_key` to `apiToken` on write.
+      required: [type, baseUrl, email]
+      additionalProperties: false
+      properties:
+        type:
+          type: string
+          enum: [jira]
+        baseUrl:
+          type: string
+          minLength: 1
+          description: Jira Cloud site URL (e.g. `https://your-domain.atlassian.net`).
+        email:
+          type: string
+          minLength: 1
+          description: Atlassian account email used with the API token.
+        apiToken:
+          type: string
+          minLength: 1
+          maxLength: 512
+          description: Atlassian API token (write-only on PUT; preferred).
+        api_key:
+          type: string
+          minLength: 1
+          maxLength: 512
+          description: >
+            Deprecated write-only alias for `apiToken`. Accepted for backward compatibility;
+            normalized to `apiToken` and never returned on GET `/config`.
+        userName:
+          type: string
+          description: Optional display name from a successful connection test (echo-after-test).
+        accountId:
+          type: string
+          description: Optional Atlassian account id from a successful connection test.
+
+    JiraSourceConfigDto:
+      type: object
+      description: >
+        Redacted Jira source returned by `GET /workspaces/{workspaceId}/config`.
+        Raw API token is never returned.
+      required: [type, hasToken, baseUrl, email]
+      additionalProperties: false
+      properties:
+        type:
+          type: string
+          enum: [jira]
+        hasToken:
+          type: boolean
+          description: Whether an API token is stored for this workspace.
+        baseUrl:
+          type: string
+          description: Configured Jira Cloud site URL.
+        email:
+          type: string
+          description: Atlassian account email associated with the stored token.
+        userName:
+          type: string
+          description: Display name when known from the last successful verify.
+        accountId:
+          type: string
+          description: Atlassian account id when known from the last successful verify.
+
     AgentExecutionProviderDto:
       type: string
       description: >
@@ -10092,6 +10323,7 @@ components:
               - $ref: "#/components/schemas/GrafanaSourceConfigDto"
               - $ref: "#/components/schemas/SonarQubeSourceConfigDto"
               - $ref: "#/components/schemas/PagerDutySourceConfigDto"
+              - $ref: "#/components/schemas/JiraSourceConfigDto"
               - $ref: "#/components/schemas/TenantSourceEntryDto"
         orgChart:
           nullable: true
@@ -10169,13 +10401,13 @@ components:
           description: Error detail when `executionKeyValid` is false.
         userName:
           type: string
-          description: Present for New Relic or Grafana verify success — authenticated user name.
+          description: Present for New Relic, Grafana, PagerDuty, or Jira verify success — authenticated user name.
         accountName:
           type: string
           description: Present for New Relic verify success — resolved account display name.
         accountId:
           type: string
-          description: Present for New Relic verify success — resolved account ID.
+          description: Present for New Relic or Jira verify success — resolved account ID.
         orgName:
           type: string
           description: Present for Grafana verify success — resolved organization name.

package/package.json

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