wip

2025-09-30 10:40:05 +01:00
parent 3d0e4f94f2
commit 9eef072f91
3 changed files with 126 additions and 97 deletions
--- a/docker-compose.unix.yml
+++ b/docker-compose.unix.yml
@@ -1,11 +1,11 @@
 services:
  valkey:
-    image: docker.io/bitnami/valkey:8.0
+    image: docker.io/valkey/valkey:8.0
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
      - VALKEY_DISABLE_COMMANDS=FLUSHDB,FLUSHALL
    volumes:
-      - valkey-data:/bitnami/valkey/data
+      - valkey-data:/valkey/valkey/data
    healthcheck:
      test: ["CMD", "redis-cli", "-h", "localhost", "-p", "6379", "ping"]
      interval: 10s
--- a/shared/api/customer.ts
+++ b/shared/api/customer.ts
@@ -8,13 +8,13 @@ import { CusResponseSchema } from "../models/cusModels/cusResponseModels.js";
 const customerId = z.string().meta({
 	description: "Your internal ID for the customer",
 	example: "cus_123",
-	id: "customerId",
+	id: "customer_id",
 });

 const featureId = z.string().meta({
 	description: "Feature ID as defined in the dashboard (eg. 'messages')",
 	example: "messages",
-	id: "featureId",
+	id: "feature_id",
 });

 const AttachResult = z
@@ -27,14 +27,16 @@ const AttachResult = z
 		product_ids: z.array(z.string()).meta({
 			description: "The IDs of the products that were attached",
 			example: ["pro", "one_off"],
-			id: "productIds",
+			id: "product_ids",
 		}),
 		customer_id: customerId,
 	})
 	.meta({ id: "AttachResult" });

 const attachDefinition = {
-	// requestParams: { path: z.object({ customerId }) },
+	summary: "Attach Product",
+	tags: ["core"],
+	"x-speakeasy-name-override": "attach",
 	requestBody: {
 		content: {
 			"application/json": { schema: AttachBodySchema },
@@ -59,6 +61,12 @@ const document = createDocument({
 		title: "My API",
 		version: "1.0.0",
 	},
+	servers: [
+		{
+			url: "https://api.useautumn.com",
+			description: "Production server",
+		},
+	],
 	security: [
 		{
 			secretKey: [],
@@ -73,10 +81,17 @@ const document = createDocument({
 			},
 		},
 	},
+
 	paths: {
-		"/customers/{customerId}": {
+		"/core/attach": {
+			post: attachDefinition,
+		},
+		"/customers/{customer_id}": {
 			get: {
-				requestParams: { path: z.object({ customerId }) },
+				summary: "Get customer",
+				"x-speakeasy-name-override": "get",
+				tags: ["customers"],
+				requestParams: { path: z.object({ customer_id: customerId }) },
 				responses: {
 					"200": {
 						description: "200 OK",
@@ -87,11 +102,14 @@ const document = createDocument({
 				},
 			},
 		},
-		"/customers/{customerId}/features/{featureId}": {
+		"/customers/{customer_id}/features/{feature_id}": {
 			patch: {
-				tags: ["customers.features"],
-				requestParams: { path: z.object({ customerId, featureId }) },
+				summary: "Update customer feature",
+				tags: ["customer.features"],
 				"x-speakeasy-name-override": "update",
+				requestParams: {
+					path: z.object({ customer_id: customerId, feature_id: featureId }),
+				},
 				requestBody: {
 					content: {
 						"application/json": {
@@ -115,7 +133,6 @@ const document = createDocument({
 				},
 			},
 		},
-		"/core/attach": { post: attachDefinition },
 	},
 });

--- a/shared/openapi.yaml
+++ b/shared/openapi.yaml
@@ -2,68 +2,18 @@ openapi: 3.1.0
 info:
  title: My API
  version: 1.0.0
+servers:
+  - url: https://api.useautumn.com
+    description: Production server
 security:
  - secretKey: []
 paths:
-  /customers/{customerId}:
-    get:
-      parameters:
-        - in: path
-          name: customerId
-          schema:
-            $ref: "#/components/schemas/customerId"
-          required: true
-          description: Your internal ID for the customer
-      responses:
-        "200":
-          description: 200 OK
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/Customer"
-  /customers/{customerId}/features/{featureId}:
-    patch:
-      tags:
-        - customers.features
-      x-speakeasy-name-override: update
-      parameters:
-        - in: path
-          name: customerId
-          schema:
-            $ref: "#/components/schemas/customerId"
-          required: true
-          description: Your internal ID for the customer
-        - in: path
-          name: featureId
-          schema:
-            $ref: "#/components/schemas/featureId"
-          required: true
-          description: Feature ID as defined in the dashboard (eg. 'messages')
-      requestBody:
-        content:
-          application/json:
-            schema:
-              type: object
-              properties:
-                usage:
-                  type: number
-              required:
-                - usage
-      responses:
-        "200":
-          description: 200 OK
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  usage:
-                    type: number
-                required:
-                  - usage
-                additionalProperties: false
  /core/attach:
    post:
+      summary: Attach Product
+      tags:
+        - core
+      x-speakeasy-name-override: attach
      requestBody:
        content:
          application/json:
@@ -377,16 +327,104 @@ paths:
            application/json:
              schema:
                $ref: "#/components/schemas/AttachResult"
+  /customers/{customer_id}:
+    get:
+      summary: Get customer
+      x-speakeasy-name-override: get
+      tags:
+        - customers
+      parameters:
+        - in: path
+          name: customer_id
+          schema:
+            $ref: "#/components/schemas/customer_id"
+          required: true
+          description: Your internal ID for the customer
+      responses:
+        "200":
+          description: 200 OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Customer"
+  /customers/{customer_id}/features/{feature_id}:
+    patch:
+      summary: Update customer feature
+      tags:
+        - customer.features
+      x-speakeasy-name-override: update
+      parameters:
+        - in: path
+          name: customer_id
+          schema:
+            $ref: "#/components/schemas/customer_id"
+          required: true
+          description: Your internal ID for the customer
+        - in: path
+          name: feature_id
+          schema:
+            $ref: "#/components/schemas/feature_id"
+          required: true
+          description: Feature ID as defined in the dashboard (eg. 'messages')
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                usage:
+                  type: number
+              required:
+                - usage
+      responses:
+        "200":
+          description: 200 OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  usage:
+                    type: number
+                required:
+                  - usage
+                additionalProperties: false
 components:
  schemas:
-    customerId:
+    customer_id:
      description: Your internal ID for the customer
      example: cus_123
      type: string
-    featureId:
+    feature_id:
      description: Feature ID as defined in the dashboard (eg. 'messages')
      example: messages
      type: string
+    AttachResult:
+      type: object
+      properties:
+        message:
+          $ref: "#/components/schemas/message"
+        product_ids:
+          $ref: "#/components/schemas/product_ids"
+        customer_id:
+          $ref: "#/components/schemas/customer_id"
+      required:
+        - message
+        - product_ids
+        - customer_id
+      additionalProperties: false
+    message:
+      description: A short description on the result of the operation
+      example: Successfully downgraded from Product A to Product B
+      type: string
+    product_ids:
+      description: The IDs of the products that were attached
+      example:
+        - pro
+        - one_off
+      type: array
+      items:
+        type: string
    Customer:
      type: object
      properties:
@@ -1412,32 +1450,6 @@ components:
        - features
        - metadata
      additionalProperties: false
-    AttachResult:
-      type: object
-      properties:
-        message:
-          $ref: "#/components/schemas/message"
-        product_ids:
-          $ref: "#/components/schemas/productIds"
-        customer_id:
-          $ref: "#/components/schemas/customerId"
-      required:
-        - message
-        - product_ids
-        - customer_id
-      additionalProperties: false
-    message:
-      description: A short description on the result of the operation
-      example: Successfully downgraded from Product A to Product B
-      type: string
-    productIds:
-      description: The IDs of the products that were attached
-      example:
-        - pro
-        - one_off
-      type: array
-      items:
-        type: string
  securitySchemes:
    secretKey:
      type: http