feat: update openapi with GET /scenario-iterations/{iterationId}/vali…

…date
checkmarble · Aug 21, 2023 · 42be5dd · 42be5dd
1 parent c8aef80
commit 42be5dd
Show file tree

Hide file tree

Showing 2 changed files with 73 additions and 10 deletions.
diff --git a/packages/marble-api/scripts/openapi.yaml b/packages/marble-api/scripts/openapi.yaml
@@ -681,10 +681,41 @@ paths:
                 type: object
                 required:
                   - iteration
-                  - scenario_validation
                 properties:
                   iteration:
                     $ref: '#/components/schemas/ScenarioIterationWithBody'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+  /scenario-iterations/{scenarioIterationId}/validate:
+    get:
+      tags:
+        - Scenario Iterations
+      summary: Validate a scenario iteration by id
+      operationId: validateScenarioIteration
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: scenarioIterationId
+          description: ID of the scenario iteration
+          in: path
+          required: true
+          schema:
+            type: string
+            format: uuid
+      responses:
+        '200':
+          description: The scenario iteration corresponding to the provided `scenarioIterationId`
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - scenario_validation
+                properties:
                   scenario_validation:
                     $ref: '#/components/schemas/ScenarioValidationDto'
         '401':
@@ -823,12 +854,9 @@ paths:
                 type: object
                 required:
                   - rule
-                  - scenario_validation
                 properties:
                   rule:
                     $ref: '#/components/schemas/ScenarioIterationRuleDto'
-                  scenario_validation:
-                    $ref: '#/components/schemas/ScenarioValidationDto'
         '401':
           $ref: '#/components/responses/401'
         '403':
@@ -2051,12 +2079,24 @@ components:
       type: object
       required:
         - return_value
-        - evaluation_error
+        - errors
       properties:
         return_value:
           $ref: '#/components/schemas/ConstantDto'
-        evaluation_error:
-          type: string
+        errors:
+          type: object
+          required:
+            - code
+            - message
+          properties:
+            code:
+              type: string
+              enum:
+                - UNEXPECTED_ERROR
+                - UNKNOWN_FUNCTION
+                - WRONG_NUMBER_OF_ARGUMENTS
+            message:
+              type: string
         children:
           type: array
           items:

diff --git a/packages/marble-api/src/generated/marble-api.ts b/packages/marble-api/src/generated/marble-api.ts
@@ -169,7 +169,10 @@ export type UpdateScenarioIterationBody = {
 };
 export type NodeEvaluationDto = {
     return_value: ConstantDto;
-    evaluation_error: string;
+    errors: {
+        code: "UNEXPECTED_ERROR" | "UNKNOWN_FUNCTION" | "WRONG_NUMBER_OF_ARGUMENTS";
+        message: string;
+    };
     children?: NodeEvaluationDto[];
     named_children?: {
         [key: string]: NodeEvaluationDto;
@@ -710,7 +713,6 @@ export function updateScenarioIteration(scenarioIterationId: string, updateScena
         status: 200;
         data: {
             iteration: ScenarioIterationWithBody;
-            scenario_validation: ScenarioValidationDto;
         };
     } | {
         status: 401;
@@ -727,6 +729,28 @@ export function updateScenarioIteration(scenarioIterationId: string, updateScena
         body: updateScenarioIterationBody
     })));
 }
+/**
+ * Validate a scenario iteration by id
+ */
+export function validateScenarioIteration(scenarioIterationId: string, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: {
+            scenario_validation: ScenarioValidationDto;
+        };
+    } | {
+        status: 401;
+        data: string;
+    } | {
+        status: 403;
+        data: string;
+    } | {
+        status: 404;
+        data: string;
+    }>(`/scenario-iterations/${encodeURIComponent(scenarioIterationId)}/validate`, {
+        ...opts
+    }));
+}
 /**
  * List rules
  */
@@ -805,7 +829,6 @@ export function updateScenarioIterationRule(ruleId: string, updateScenarioIterat
         status: 200;
         data: {
             rule: ScenarioIterationRuleDto;
-            scenario_validation: ScenarioValidationDto;
         };
     } | {
         status: 401;