The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.
TypeScript clickhousemysqlnextjsopen-sourceplanetscaleprismatailwindcsstinybirdtypescriptupstashvercel
improve OpenAPI descriptions
Steven Tey0ff5c3244d73
diff --git a/apps/web/lib/openapi/discount-codes/create-discount-code.ts b/apps/web/lib/openapi/discount-codes/create-discount-code.tsindex 60f73eab84..2de1f2ebf9 100644--- a/apps/web/lib/openapi/discount-codes/create-discount-code.ts+++ b/apps/web/lib/openapi/discount-codes/create-discount-code.ts@@ -10,7 +10,7 @@ export const createDiscountCode: ZodOpenApiOperationObject = {"x-speakeasy-name-override": "create",summary: "Create a discount code",description:- "Create a discount code for a partner. A discount must already be assigned to the partner's group, and the specified link cannot already have a discount code.",+ "Create a discount code for a partner. The partner's group must already have a discount assigned to it, and the discount code must be associated with a link that is not already linked with another discount code.",requestBody: {content: {"application/json": {diff --git a/apps/web/lib/openapi/discount-codes/delete-discount-code.ts b/apps/web/lib/openapi/discount-codes/delete-discount-code.tsindex 1f7edac6e6..9f4d41a7d3 100644--- a/apps/web/lib/openapi/discount-codes/delete-discount-code.ts+++ b/apps/web/lib/openapi/discount-codes/delete-discount-code.ts@@ -9,7 +9,7 @@ export const deleteDiscountCode: ZodOpenApiOperationObject = {"x-speakeasy-max-method-params": 1,summary: "Delete a discount code",description:- "Delete a discount code for a partner. This will also disable the code in your connected discount provider (Stripe, Shopify, or custom via webhook).",+ "Delete a discount code for a partner. This will also disable the code in your connected discount provider (Stripe, Shopify, or custom via `disccount.deleted` webhook).",requestParams: {path: z.object({id: DiscountCodeSchema.shape.id.describe(diff --git a/apps/web/lib/openapi/discount-codes/list-discount-codes.ts b/apps/web/lib/openapi/discount-codes/list-discount-codes.tsindex fd93c8ffb0..d35965253f 100644--- a/apps/web/lib/openapi/discount-codes/list-discount-codes.ts+++ b/apps/web/lib/openapi/discount-codes/list-discount-codes.ts@@ -11,7 +11,7 @@ export const listDiscountCodes: ZodOpenApiOperationObject = {"x-speakeasy-name-override": "list",summary: "List discount codes",description:- "Retrieve a paginated list of discount codes for the partner program.",+ "Retrieve a paginated list of discount codes for a partner / a given discount / the whole program.",requestParams: {query: getDiscountCodesQuerySchema,},diff --git a/apps/web/lib/zod/schemas/discount.ts b/apps/web/lib/zod/schemas/discount.tsindex f0d70ed15b..eddb99b8f3 100644--- a/apps/web/lib/zod/schemas/discount.ts+++ b/apps/web/lib/zod/schemas/discount.ts@@ -63,7 +63,9 @@ export const DiscountCodeSchema = z}),code: z.string()- .describe("The discount code that customers can apply at checkout.")+ .describe(+ "The alphanumeric discount code that customers can apply at checkout.",+ ).meta({example: "PARTNER10OFF",}),@@ -83,7 +85,7 @@ export const DiscountCodeSchema = z.date().nullish().describe(- "When this discount code was disabled, which happens when a partner is banned or deactivated.",+ "When this discount code was disabled, which happens when a partner is banned or deactivated. We don't delete the discount code to avoid another partner claiming a banned/deactivated code (abuse vector).",),}).meta({