Skip to content

Commit 03f2889

Browse files
authored
fix: plan list documentation (#2466)
1 parent 853ea16 commit 03f2889

File tree

6 files changed

+435
-423
lines changed

6 files changed

+435
-423
lines changed

api/api.gen.go

+309-306
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

api/client/go/client.gen.go

+105-102
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

api/client/javascript/src/client/schemas.ts

+6-9
Original file line numberDiff line numberDiff line change
@@ -6360,11 +6360,6 @@ export interface components {
63606360
* @enum {string}
63616361
*/
63626362
PlanStatus: 'draft' | 'active' | 'archived' | 'scheduled'
6363-
/**
6364-
* @description Filter by plan status.
6365-
* @enum {string}
6366-
*/
6367-
PlanStatusFilterEnum: 'active' | 'draft' | 'archived'
63686363
/** @description Change subscription based on plan. */
63696364
PlanSubscriptionChange: {
63706365
/** @description Timing configuration for the change, when the change should take effect.
@@ -8400,7 +8395,6 @@ export type PlanReference = components['schemas']['PlanReference']
84008395
export type PlanReferenceInput = components['schemas']['PlanReferenceInput']
84018396
export type PlanReplaceUpdate = components['schemas']['PlanReplaceUpdate']
84028397
export type PlanStatus = components['schemas']['PlanStatus']
8403-
export type PlanStatusFilterEnum = components['schemas']['PlanStatusFilterEnum']
84048398
export type PlanSubscriptionChange =
84058399
components['schemas']['PlanSubscriptionChange']
84068400
export type PlanSubscriptionCreate =
@@ -15221,10 +15215,13 @@ export interface operations {
1522115215
keyVersion?: {
1522215216
[key: string]: number[]
1522315217
}
15224-
/** @description Only return the latest version of the plan for each key.
15218+
/** @description Only return plans with the given status.
1522515219
*
15226-
* Usage: `?status=latest` */
15227-
status?: components['schemas']['PlanStatusFilterEnum'][]
15220+
* Usage:
15221+
* - `?status=active`: return only the currently active plan
15222+
* - `?status=draft`: return only the draft plan
15223+
* - `?status=archived`: return only the archived plans */
15224+
status?: components['schemas']['PlanStatus'][]
1522815225
/** @description Filter by plan.currency attribute */
1522915226
currency?: components['schemas']['CurrencyCode'][]
1523015227
/** @description Start date-time in RFC 3339 format.

0 commit comments

Comments
 (0)