Skip to content

Commit 0cce635

Browse files
committed
fix API docs
1 parent f765edd commit 0cce635

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/api/routes/events.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ const zodIncludeMetadata = z.coerce
8585
.default(false)
8686
.optional()
8787
.openapi({
88-
description: "If true, metadata for each event entry.",
88+
description: "If true, include metadata for each event entry.",
8989
});
9090
export const CLIENT_HTTP_CACHE_POLICY = `public, max-age=${EVENT_CACHED_DURATION}, stale-while-revalidate=420, stale-if-error=3600`;
9191
export type EventRepeatOptions = (typeof repeatOptions)[number];
@@ -141,7 +141,7 @@ const eventsPlugin: FastifyPluginAsyncZodOpenApi = async (
141141
querystring: z.object({
142142
upcomingOnly: z.coerce.boolean().default(false).optional().openapi({
143143
description:
144-
"If true, only get events which end after the current time.",
144+
"If true, only get events which have at least one occurance starting after the current time.",
145145
}),
146146
featuredOnly: z.coerce.boolean().default(false).optional().openapi({
147147
description:
@@ -150,7 +150,9 @@ const eventsPlugin: FastifyPluginAsyncZodOpenApi = async (
150150
host: z
151151
.enum(OrganizationList as [string, ...string[]])
152152
.optional()
153-
.openapi({ description: "Event host filter." }),
153+
.openapi({
154+
description: "Retrieve events only for a specific host.",
155+
}),
154156
ts,
155157
includeMetadata: zodIncludeMetadata,
156158
}),

0 commit comments

Comments
 (0)