Skip to content

armgit / dub

Public Imported from GitHub
0

The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.

update openapi specs

Steven Teye1818094f715
diff --git a/apps/web/lib/openapi/bounties/list-bounty-submissions.ts b/apps/web/lib/openapi/bounties/list-bounty-submissions.ts
index 5070f32aba..e7323e7747 100644
--- a/apps/web/lib/openapi/bounties/list-bounty-submissions.ts
+++ b/apps/web/lib/openapi/bounties/list-bounty-submissions.ts
@@ -10,10 +10,14 @@ export const listBountySubmissions: ZodOpenApiOperationObject = {
operationId: "listBountySubmissions",
"x-speakeasy-name-override": "listSubmissions",
summary: "List bounty submissions",
- description: "List all submissions for a specific bounty.",
+ description:
+ "List all submissions for a specific bounty in your partner program.",
requestParams: {
path: z.object({
- bountyId: z.string().meta({ description: "The ID of the bounty" }),
+ bountyId: z.string().meta({
+ description:
+ "The unique ID of the bounty on Dub. Can be found in the URL of the bounty page, prefixed with `bnty_`.",
+ }),
}),
query: getBountySubmissionsQuerySchema,
},
diff --git a/apps/web/lib/openapi/commissions/list-commissions.ts b/apps/web/lib/openapi/commissions/list-commissions.ts
index bb4452df41..c4a0df3744 100644
--- a/apps/web/lib/openapi/commissions/list-commissions.ts
+++ b/apps/web/lib/openapi/commissions/list-commissions.ts
@@ -9,8 +9,8 @@ import { openApiErrorResponses } from "../responses";
export const listCommissions: ZodOpenApiOperationObject = {
operationId: "listCommissions",
"x-speakeasy-name-override": "list",
- summary: "Get commissions for a program.",
- description: "Retrieve a list of commissions for a program.",
+ summary: "List all commissions",
+ description: "Retrieve a list of commissions for your partner program.",
requestParams: {
query: getCommissionsQuerySchema,
},
diff --git a/apps/web/lib/openapi/payouts/list-payouts.ts b/apps/web/lib/openapi/payouts/list-payouts.ts
index 79a6252293..01fd5f4670 100644
--- a/apps/web/lib/openapi/payouts/list-payouts.ts
+++ b/apps/web/lib/openapi/payouts/list-payouts.ts
@@ -9,8 +9,8 @@ import * as z from "zod/v4";
export const listPayouts: ZodOpenApiOperationObject = {
operationId: "listPayouts",
"x-speakeasy-name-override": "list",
- summary: "Get payouts for a program.",
- description: "Retrieve a list of payouts for the workspace default program.",
+ summary: "List all payouts",
+ description: "Retrieve a list of payouts for your partner program.",
requestParams: {
query: payoutsQuerySchema,
},
diff --git a/apps/web/lib/zod/schemas/payouts.ts b/apps/web/lib/zod/schemas/payouts.ts
index 3a27fa2f5d..deadd2783c 100644
--- a/apps/web/lib/zod/schemas/payouts.ts
+++ b/apps/web/lib/zod/schemas/payouts.ts
@@ -29,23 +29,25 @@ export const payoutsQuerySchema = z
status: z
.enum(PayoutStatus)
.optional()
- .describe("Filter the list of payouts by status."),
+ .describe("Filter the list of payouts by their corresponding status."),
partnerId: z
.string()
.optional()
.describe(
- "Associated partner ID. When specified, takes precedence over tenantId.",
+ "Filter the list of payouts by the associated partner. When specified, takes precedence over `tenantId`.",
),
tenantId: z
.string()
.optional()
.describe(
- "Associated partner's tenantId (their unique ID within your database).",
+ "Filter the list of payouts by the associated partner's `tenantId` (their unique ID within your database).",
),
invoiceId: z
.string()
.optional()
- .describe("Filter the list of payouts by invoice ID."),
+ .describe(
+ "Filter the list of payouts by invoice ID (the unique ID of the invoice you receive for each batch payout you process on Dub). Pending payouts will not have an invoice ID.",
+ ),
sortBy: z
.enum(["amount", "initiatedAt", "paidAt"])
.default("amount")