aboutsummaryrefslogtreecommitdiffstats
path: root/packages/open-api/lib/users.ts
blob: fa512a80af5d0a90d9e44c70bfffc3103fd7edf0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
import {
  extendZodWithOpenApi,
  OpenAPIRegistry,
} from "@asteasolutions/zod-to-openapi";
import { z } from "zod";

import {
  zUserStatsResponseSchema,
  zWhoAmIResponseSchema,
} from "@karakeep/shared/types/users";

import { BearerAuth } from "./common";

export const registry = new OpenAPIRegistry();
extendZodWithOpenApi(z);

registry.registerPath({
  method: "get",
  path: "/users/me",
  description: "Returns info about the current user",
  summary: "Get current user info",
  tags: ["Users"],
  security: [{ [BearerAuth.name]: [] }],
  request: {},
  responses: {
    200: {
      description: "Object with user data.",
      content: {
        "application/json": {
          schema: zWhoAmIResponseSchema,
        },
      },
    },
  },
});

registry.registerPath({
  method: "get",
  path: "/users/me/stats",
  description: "Returns stats about the current user",
  summary: "Get current user stats",
  tags: ["Users"],
  security: [{ [BearerAuth.name]: [] }],
  request: {},
  responses: {
    200: {
      description: "Object with user stats.",
      content: {
        "application/json": {
          schema: zUserStatsResponseSchema,
        },
      },
    },
  },
});