update naming

dubinc · Mar 3, 2025 · 99d2198 · 99d2198
1 parent c522570
commit 99d2198
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/apps/web/lib/openapi/partners/index.ts b/apps/web/lib/openapi/partners/index.ts
@@ -2,7 +2,7 @@ import { ZodOpenApiPathsObject } from "zod-openapi";
 import { createPartner } from "./create-partner";
 import { createPartnerLink } from "./create-partner-link";
 import { retrievePartnerAnalytics } from "./retrieve-analytics";
-import { updateSale } from "./update-sale";
+import { updatePartnerSale } from "./update-partner-sale";
 import { upsertPartnerLink } from "./upsert-partner-link";
 
 export const partnersPaths: ZodOpenApiPathsObject = {
@@ -19,6 +19,6 @@ export const partnersPaths: ZodOpenApiPathsObject = {
     get: retrievePartnerAnalytics,
   },
   "/partners/sales": {
-    patch: updateSale,
+    patch: updatePartnerSale,
   },
 };
diff --git a/apps/web/lib/openapi/partners/update-sale.ts → ...b/openapi/partners/update-partner-sale.ts b/apps/web/lib/openapi/partners/update-sale.ts → ...b/openapi/partners/update-partner-sale.ts
@@ -3,12 +3,12 @@ import { updatePartnerSaleSchema } from "../../zod/schemas/partners";
 import { ProgramSaleSchema } from "../../zod/schemas/program-sales";
 import { openApiErrorResponses } from "../responses";
 
-export const updateSale: ZodOpenApiOperationObject = {
-  operationId: "updateSale",
+export const updatePartnerSale: ZodOpenApiOperationObject = {
+  operationId: "updatePartnerSale",
   "x-speakeasy-name-override": "updateSale",
-  summary: "Update an existing sale.",
+  summary: "Update a sale for a partner.",
   description:
-    "This is useful if you need to change the amount of a sale after it has been created.",
+    "Update an existing sale amount. This is useful for handling refunds (partial or full) or fraudulent sales.",
   requestBody: {
     content: {
       "application/json": {