From e03c77792127864b439a2483e647cb2506322555 Mon Sep 17 00:00:00 2001 From: Morten Date: Wed, 10 Sep 2025 05:19:56 +0000 Subject: [PATCH] swagger improvements --- packages/server/src/api/api.ts | 6 +++++- packages/server/src/api/endpoints/endpoints.stream.ts | 2 +- packages/server/src/cli.ts | 1 + 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/packages/server/src/api/api.ts b/packages/server/src/api/api.ts index 89326b2..a9b09ed 100644 --- a/packages/server/src/api/api.ts +++ b/packages/server/src/api/api.ts @@ -21,7 +21,7 @@ const createApi = async (options: CreateApiOptions) => { openapi: { info: { title: 'FluxCurrent', - description: 'Sample backend service', + description: 'A home for all data', version: '1.0.0', }, tags: [ @@ -37,6 +37,10 @@ const createApi = async (options: CreateApiOptions) => { await app.register(fastifyApiReference, { routePrefix: '/docs', + configuration: { + theme: 'elysiajs', + pageTitle: 'FluxCurrent API', + }, }); await app.register(FastifySSEPlugin); diff --git a/packages/server/src/api/endpoints/endpoints.stream.ts b/packages/server/src/api/endpoints/endpoints.stream.ts index 1666c30..8db1315 100644 --- a/packages/server/src/api/endpoints/endpoints.stream.ts +++ b/packages/server/src/api/endpoints/endpoints.stream.ts @@ -12,7 +12,7 @@ const streamEndpoint: FastifyPluginAsyncZod<{ services: Services }> = async (fas url: '/documents', schema: { operationId: 'get.stream.documents', - summary: 'Stream documents matching a query', + summary: 'Subscribe to documents matching a query', tags: ['streams', 'documents'], querystring: z.object({ query: z.string().optional(), diff --git a/packages/server/src/cli.ts b/packages/server/src/cli.ts index 0481b6a..a5a6f7f 100644 --- a/packages/server/src/cli.ts +++ b/packages/server/src/cli.ts @@ -6,3 +6,4 @@ const services = new Services(); const api = await createApi({ services }); await api.listen({ port: 3000 }); +console.log('Started');