@thinkai/tai-api-contract 2.186.0 → 2.188.0

package/openapi/openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ThinkAI API
-  version: 2.186.0
+  version: 2.188.0
   description: >
     Contract surface for the AI Driven SDLC backend used by ThinkAI.
     Workspace-scoped routes use `/workspaces/{workspaceId}/...`.
@@ -9326,6 +9326,143 @@ paths:
               schema:
                 $ref: "#/components/schemas/GithubPermissionsCheckFailedErrorDto"
 
+  /workspaces/{workspaceId}/rules-skills/validate:
+    post:
+      tags: [AgenticFoundation]
+      summary: Validate agent rules and skills for a repository
+      description: >
+        Clones the connected GitHub repository via the workspace GitHub App installation
+        and runs the shared Rules & Skills validate engine (structural + soft quality).
+        Assessed tools come from the latest **succeeded** readiness scan
+        (`agent_tool_assessed`: `cursor` | `claude-code` | `both`). Returns draft
+        `proposedFiles` for review (not committed). Workspace member auth; write
+        permissions are not required for validate-only.
+      operationId: postRulesSkillsValidate
+      parameters:
+        - $ref: "#/components/parameters/WorkspaceId"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/RulesSkillsValidateRequestDto"
+            examples:
+              validate:
+                value:
+                  repoId: "11111111-1111-4111-8111-111111111111"
+                  pathPrefixes:
+                    - ".cursor"
+      responses:
+        "200":
+          description: Validation result with findings and draft proposed files
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/RulesSkillsValidateResponseDto"
+        "400":
+          description: Invalid body (e.g. malformed 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 / not connected
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+        "422":
+          description: >
+            No succeeded readiness scan for the repo (`code: readiness_scan_required`),
+            or repository is not a GitHub-connected readiness repo.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+              examples:
+                readiness_scan_required:
+                  value:
+                    error: Run an Agentic Foundation readiness scan before validating rules and skills
+                    code: readiness_scan_required
+        "503":
+          description: Clone or GitHub App configuration failed
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+
+  /workspaces/{workspaceId}/rules-skills/pull-requests:
+    post:
+      tags: [AgenticFoundation]
+      summary: Open a Rules & Skills remediation pull request
+      description: >
+        Applies `proposedFiles` (or a future create-mode session) onto a non-default
+        branch via the Automations GitHub App installation and opens a pull request.
+        Never pushes to the default branch. PR title/body identify the change as
+        platform-generated and link back to `/agentic-foundation/rules-skills`.
+        Requires workspace editor or admin. Same write-permission gate as readiness fixes.
+      operationId: postRulesSkillsPullRequest
+      parameters:
+        - $ref: "#/components/parameters/WorkspaceId"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/RulesSkillsOpenPullRequestRequestDto"
+            examples:
+              validateMode:
+                value:
+                  repoId: "11111111-1111-4111-8111-111111111111"
+                  mode: validate
+                  proposedFiles:
+                    - path: ".cursor/rules/foo.mdc"
+                      action: rename
+                      previousPath: ".cursor/rules/foo.md"
+                      content: "---\ndescription: example\nglobs: \"**/*\"\n---\n"
+      responses:
+        "200":
+          description: Pull request created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/RulesSkillsOpenPullRequestResponseDto"
+        "400":
+          description: >
+            Missing proposed files or invalid body (`code: proposed_files_required`).
+          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"
+        "422":
+          description: GitHub installation lacks write permissions required for automated PRs
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GithubWritePermissionsRequiredErrorDto"
+        "503":
+          description: GitHub installation permissions could not be verified, or PR create failed
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - $ref: "#/components/schemas/GithubPermissionsCheckFailedErrorDto"
+                  - $ref: "#/components/schemas/ErrorMessageDto"
+
   /workspaces/{workspaceId}/readiness/issues/{issueId}/fix-guide:
     get:
       tags: [RepositoryReadiness]
@@ -17428,20 +17565,107 @@ components:
           items:
             $ref: "#/components/schemas/AiUsageSpendAggregatedContributorRowDto"
 
+    AiUsageSpendKeyInsightModelRightSizingEvidenceDto:
+      type: object
+      additionalProperties: false
+      description: >
+        Numeric evidence for `id=model_right_sizing` (Cost-to-Value insight #2).
+        Premium share is `premiumSpendCents / totalModelSpendCents` against
+        `thresholdPct` (Phase A default 40).
+      required:
+        - premiumSharePct
+        - premiumSpendCents
+        - totalModelSpendCents
+        - thresholdPct
+        - personCount
+      properties:
+        premiumSharePct:
+          type: number
+          description: Premium-model share of model spend in the window (0–100).
+        premiumSpendCents:
+          type: integer
+          description: Sum of spend_cents on premium-classified models (cents).
+        totalModelSpendCents:
+          type: integer
+          description: Sum of spend_cents across all models in the window (cents).
+        thresholdPct:
+          type: number
+          description: Effective premium-share threshold used for this card (0–100).
+        personCount:
+          type: integer
+          description: >
+            Distinct mapped person_id rows contributing to this card's sample
+            (workspace rollup or the single person for a person-scoped card).
+
+    AiUsageSpendKeyInsightDrilldownDto:
+      type: object
+      additionalProperties: false
+      description: >
+        Optional member drill-down for person-scoped `model_right_sizing` cards.
+        Links to `GET …/integrations/ai-tool/{provider}/members/{externalId}`.
+      required: [provider, externalId]
+      properties:
+        provider:
+          type: string
+          enum: [cursor, claude]
+          description: AI tool provider for the member detail route.
+        externalId:
+          type: string
+          description: Provider member external id for the member detail route.
+
     AiUsageSpendKeyInsightItemDto:
       type: object
       additionalProperties: false
       required: [id, tone, text]
+      description: >
+        One Key Insights panel card. Base fields (`id`, `tone`, `text`) apply to
+        all insights. When `id` is `model_right_sizing`, clients MUST treat
+        `dataQuality`, `limitation`, `recommendedAction`, and `evidence` as
+        required; `scope` and `drilldown` are optional (person cards may set both).
       properties:
         id:
           type: string
-          description: Stable insight key (e.g. spend-leader, spend-vs-output).
+          description: >
+            Stable insight key (e.g. spend-leader, spend-vs-output,
+            model_right_sizing).
         tone:
           type: string
           enum: [positive, warning, neutral]
         text:
           type: string
           description: Human-readable insight sentence for the UI panel.
+        dataQuality:
+          allOf:
+            - $ref: "#/components/schemas/AiAssistedCodeDataQuality"
+          description: >
+            Required when `id=model_right_sizing`. Phase A/B always `estimated`
+            (model-mix heuristic; no task-complexity telemetry until Phase 3).
+        limitation:
+          type: string
+          description: >
+            Required when `id=model_right_sizing`. Fixed honesty string that the
+            model mix is heuristic and does not encode task complexity.
+        recommendedAction:
+          type: string
+          description: >
+            Required when `id=model_right_sizing`. Coaching copy for the card CTA
+            (advisory only; not vendor enforcement).
+        evidence:
+          allOf:
+            - $ref: "#/components/schemas/AiUsageSpendKeyInsightModelRightSizingEvidenceDto"
+          description: Required when `id=model_right_sizing`.
+        scope:
+          type: string
+          enum: [workspace, person]
+          description: >
+            Optional scope for `model_right_sizing` cards. Workspace default vs
+            per-person personalized item.
+        drilldown:
+          allOf:
+            - $ref: "#/components/schemas/AiUsageSpendKeyInsightDrilldownDto"
+          description: >
+            Optional when `scope=person` for `model_right_sizing`; omitted on
+            workspace cards.
 
     AiUsageSpendKeyInsightsDto:
       type: object
@@ -22455,6 +22679,170 @@ components:
             Required when the issue has unresolvedChoices. Must be one of those labels.
             Stored on the fix row and stated in the worker prompt.
 
+    RulesSkillsAssessedTools:
+      type: string
+      enum: [cursor, claude-code, both]
+      description: >
+        From the latest succeeded readiness scan (`agent_tool_assessed`). Never invent
+        `both` without scan evidence.
+
+    RulesSkillsValidateRequestDto:
+      type: object
+      additionalProperties: false
+      required: [repoId]
+      properties:
+        repoId:
+          type: string
+          format: uuid
+        pathPrefixes:
+          type: array
+          maxItems: 32
+          items:
+            type: string
+            maxLength: 512
+          description: Optional relative path prefixes limiting the validate walk.
+
+    RulesSkillsFindingDto:
+      type: object
+      additionalProperties: false
+      required: [id, kind, severity, code, path, message, criterionIds]
+      properties:
+        id:
+          type: string
+        kind:
+          type: string
+          enum: [structural, soft]
+        severity:
+          type: string
+          enum: [fail, warn]
+        code:
+          type: string
+        path:
+          type: string
+        message:
+          type: string
+        criterionIds:
+          type: array
+          items:
+            type: string
+            enum: [A1, A2, A3, A3a, A3b, A3c, A11]
+          description: Empty when unmapped structural noise.
+
+    RulesSkillsSoftQualityCheckDto:
+      type: object
+      additionalProperties: false
+      required: [code, status]
+      properties:
+        code:
+          type: string
+        status:
+          type: string
+          enum: [pass, fail, warn, skip]
+        message:
+          type: string
+        path:
+          type: string
+
+    RulesSkillsSoftQualitySummaryDto:
+      type: object
+      additionalProperties: false
+      required: [passed, failCount, warnCount, checks]
+      properties:
+        passed:
+          type: boolean
+          description: True when there are no soft-quality fail findings (warns allowed).
+        failCount:
+          type: integer
+          minimum: 0
+        warnCount:
+          type: integer
+          minimum: 0
+        checks:
+          type: array
+          items:
+            $ref: "#/components/schemas/RulesSkillsSoftQualityCheckDto"
+
+    RulesSkillsProposedFileDto:
+      type: object
+      additionalProperties: false
+      required: [path, action]
+      properties:
+        path:
+          type: string
+          maxLength: 1024
+        action:
+          type: string
+          enum: [create, update, delete, rename]
+        content:
+          type: string
+          description: Full file contents for create/update/rename target.
+        previousPath:
+          type: string
+          maxLength: 1024
+          description: Source path when action is rename.
+
+    RulesSkillsValidateResponseDto:
+      type: object
+      additionalProperties: false
+      required: [assessedTools, findings, softQualitySummary, proposedFiles]
+      properties:
+        assessedTools:
+          $ref: "#/components/schemas/RulesSkillsAssessedTools"
+        findings:
+          type: array
+          items:
+            $ref: "#/components/schemas/RulesSkillsFindingDto"
+        softQualitySummary:
+          $ref: "#/components/schemas/RulesSkillsSoftQualitySummaryDto"
+        proposedFiles:
+          type: array
+          items:
+            $ref: "#/components/schemas/RulesSkillsProposedFileDto"
+        note:
+          type: string
+          description: Quiet-case note (e.g. empty tree under pathPrefixes).
+
+    RulesSkillsOpenPullRequestRequestDto:
+      type: object
+      additionalProperties: false
+      required: [repoId, mode]
+      properties:
+        repoId:
+          type: string
+          format: uuid
+        mode:
+          type: string
+          enum: [validate, create]
+        sessionId:
+          type: string
+          format: uuid
+          description: Reserved for Create-mode sessions; validate mode uses proposedFiles.
+        proposedFiles:
+          type: array
+          minItems: 1
+          maxItems: 200
+          items:
+            $ref: "#/components/schemas/RulesSkillsProposedFileDto"
+        title:
+          type: string
+          maxLength: 200
+        body:
+          type: string
+          maxLength: 8000
+
+    RulesSkillsOpenPullRequestResponseDto:
+      type: object
+      additionalProperties: false
+      required: [prUrl, prNumber, branchName]
+      properties:
+        prUrl:
+          type: string
+          format: uri
+        prNumber:
+          type: integer
+        branchName:
+          type: string
+
     PhaseRoleDto:
       type: object
       required: [phase, assignment]

package/package.json

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