feat!: making enum evolution safer

e2e/openapi.yaml

@@ -11,7 +11,7 @@ servers:
       host:
         default: localhost
       protocol:
-        enum: [http, https]
+        enum: [ http, https ]
         default: http
       port:
         default: '8080'
@@ -74,6 +74,23 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/RandomNumber'
+  /validation/enums:
+    post:
+      tags:
+        - validation
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Enumerations'
+      responses:
+        200:
+          description: ok
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Enumerations'
   /responses/empty:
     get:
       tags:
@@ -96,6 +113,24 @@ components:
                 additionalProperties: true
 
   schemas:
+    Enumerations:
+      type: object
+      required:
+        - colors
+        - starRatings
+      properties:
+        colors:
+          type: string
+          enum:
+            - red
+            - green
+            - blue
+        starRatings:
+          type: number
+          enum:
+            - 1
+            - 2
+            - 3
     RandomNumber:
       type: object
       properties:

e2e/src/index.axios.spec.ts

@@ -200,6 +200,21 @@ describe("e2e - typescript-axios client", () => {
     })
   })
 
+  describe("POST /validation/enumeration", () => {
+    it("should error if the server receives an unknown enum value", async () => {
+      const res = client.postValidationEnums({
+        requestBody: {
+          // @ts-expect-error: purple isn't a valid enum value
+          colors: "purple",
+          starRatings: 1,
+        },
+      })
+
+      await expect(res).rejects.toThrow("Request failed with status code 400")
+    })
+    // TODO: figure out how to make a skew between client/server to test client receiving extraneous values
+  })
+
   describe("GET /responses/empty", () => {
     it("returns undefined", async () => {
       const {status, data} = await client.getResponsesEmpty()