feat(api): add AI description endpoint for scenario iteration rules

- Introduced a new endpoint `/scenario-iteration-rules/{ruleId}/ai-description` to retrieve the AI description for a specific scenario iteration rule.
- Added `ScenarioIterationRuleAiDescriptionDto` schema to define the response structure.
- Updated TypeScript definitions to include the new API functionality.

Author: OrriMandarin

packages/marble-api/openapis/marblecore-api.yaml

@@ -221,6 +221,8 @@ paths:
     $ref: ./marblecore-api/scenario-iteration-rules.yml#/~1scenario-iteration-rules
   /scenario-iteration-rules/{ruleId}:
     $ref: ./marblecore-api/scenario-iteration-rules.yml#/~1scenario-iteration-rules~1{ruleId}
+  /scenario-iteration-rules/{ruleId}/ai-description:
+    $ref: ./marblecore-api/scenario-iteration-rules.yml#/~1scenario-iteration-rules~1{ruleId}~1ai-description
 
   # SCENARIO PUBLICATIONS
 

packages/marble-api/openapis/marblecore-api/_schemas.yml

@@ -253,6 +253,8 @@ ScenarioIterationRuleDto:
   $ref: scenario-iteration-rules.yml#/components/schemas/ScenarioIterationRuleDto
 ScenarioValidationDto:
   $ref: scenario-iterations.yml#/components/schemas/ScenarioValidationDto
+ScenarioIterationRuleAiDescriptionDto:
+  $ref: scenario-iteration-rules.yml#/components/schemas/ScenarioIterationRuleAiDescriptionDto
 
 # SCREENINGS
 

packages/marble-api/openapis/marblecore-api/scenario-iteration-rules.yml

@@ -73,7 +73,7 @@
       - bearerAuth: []
     parameters:
       - name: ruleId
-        description: ID of the rule that need to be fetched
+        description: ID of the rule that needs to be fetched
         in: path
         required: true
         schema:
@@ -106,7 +106,7 @@
       - bearerAuth: []
     parameters:
       - name: ruleId
-        description: ID of the rule that need to be updated
+        description: ID of the rule that needs to be updated
         in: path
         required: true
         schema:
@@ -146,7 +146,7 @@
       - bearerAuth: []
     parameters:
       - name: ruleId
-        description: ID of the rule that need to be delete
+        description: ID of the rule that needs to be delete
         in: path
         required: true
         schema:
@@ -162,6 +162,36 @@
       '404':
         $ref: 'components.yml#/responses/404'
 
+/scenario-iteration-rules/{ruleId}/ai-description:
+  get:
+    tags:
+      - Scenario Iteration Rules
+    summary: Get AI description for a scenario iteration rule
+    operationId: getScenarioIterationRuleAiDescription
+    security:
+      - bearerAuth: []
+    parameters:
+      - name: ruleId
+        description: ID of the rule that needs to be fetched
+        in: path
+        required: true
+        schema:
+          type: string
+          format: uuid
+    responses:
+      '200':
+        description: The AI description for the scenario iteration rule corresponding to the provided `ruleId`
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ScenarioIterationRuleAiDescriptionDto'
+      '401':
+        $ref: 'components.yml#/responses/401'
+      '403':
+        $ref: 'components.yml#/responses/403'
+      '404':
+        $ref: 'components.yml#/responses/404'
+
 components:
   schemas:
     ScenarioIterationRuleDto:
@@ -245,3 +275,11 @@ components:
             - $ref: 'ast.yml#/components/schemas/NodeDto'
         score_modifier:
           type: integer
+    ScenarioIterationRuleAiDescriptionDto:
+      type: object
+      properties:
+        description:
+          description: The AI description for the scenario iteration rule
+          type: string
+      required:
+        - description

packages/marble-api/src/generated/marblecore-api.ts

@@ -960,6 +960,10 @@ export type UpdateScenarioIterationRuleBodyDto = {
     formula_ast_expression?: (NodeDto) | null;
     score_modifier?: number;
 };
+export type ScenarioIterationRuleAiDescriptionDto = {
+    /** The AI description for the scenario iteration rule */
+    description: string;
+};
 export type PublicationAction = "publish" | "unpublish";
 export type ScenarioPublication = {
     id: string;
@@ -3294,6 +3298,26 @@ export function deleteScenarioIterationRule(ruleId: string, opts?: Oazapfts.Requ
         method: "DELETE"
     }));
 }
+/**
+ * Get AI description for a scenario iteration rule
+ */
+export function getScenarioIterationRuleAiDescription(ruleId: string, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: ScenarioIterationRuleAiDescriptionDto;
+    } | {
+        status: 401;
+        data: string;
+    } | {
+        status: 403;
+        data: string;
+    } | {
+        status: 404;
+        data: string;
+    }>(`/scenario-iteration-rules/${encodeURIComponent(ruleId)}/ai-description`, {
+        ...opts
+    }));
+}
 /**
  * List scenario publications
  */