Convert TaskDuration into an alias type

artefactual-labs · Jul 8, 2024 · b0b9af2 · b0b9af2
1 parent 9949df4
commit b0b9af2
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 7 deletions.
diff --git a/typespec/common.tsp b/typespec/common.tsp
@@ -17,6 +17,14 @@ scalar exitCode extends uint8;
 @doc("E.g.: \"2020-01-17T00:44:37\".")
 scalar timestamp extends string;
 
+alias TaskDuration = DurationString | int64;
+
+@extension("x-enum-varnames", ["Empty", "LowerThanOne"]) // Used to solve name clash in oapi-codegen.
+enum DurationString {
+    Empty: "";
+    LowerThanOne: "< 1";
+}
+
 enum UnitStatus {
     USER_INPUT,
     FAILED,

diff --git a/typespec/main.tsp b/typespec/main.tsp
@@ -6,6 +6,7 @@ import "@typespec/versioning";
 
 import "./common.tsp";
 
+using TypeSpec.OpenAPI;
 using TypeSpec.Http;
 using TypeSpec.Versioning;
 
@@ -404,10 +405,8 @@ namespace Service {
                 time_ended?: timestamp;
 
                 @doc("Task duration in seconds (integer). If the duration is less than a second, this will be a \"< 1\" string.")
-                duration: "< 1" | "" | int64;
+                duration: TaskDuration;
             }
-
-
         }
 
         @route("/validate")

diff --git a/typespec/tsp-output/@typespec/openapi3/openapi.v1.yaml b/typespec/tsp-output/@typespec/openapi3/openapi.v1.yaml
@@ -992,6 +992,14 @@ security:
   - ApiKeyAuth: []
 components:
   schemas:
+    DurationString:
+      type: string
+      enum:
+        - ''
+        - < 1
+      x-enum-varnames:
+        - Empty
+        - LowerThanOne
     Error:
       type: object
       required:
@@ -1289,10 +1297,7 @@ components:
           $ref: '#/components/schemas/timestamp'
         duration:
           anyOf:
-            - type: string
-              enum:
-                - < 1
-                - ''
+            - $ref: '#/components/schemas/DurationString'
             - type: integer
               format: int64
           description: Task duration in seconds (integer). If the duration is less than a second, this will be a "< 1" string.