compeller/examples/parameters/openapi/spec.ts at 748a128c4fcda65b10c46f3c38e7ffe4f008c8d6 · simonireilly/compeller · GitHub

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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
import { JSONSchema } from 'json-schema-to-ts';
import { ParameterObject } from 'openapi3-ts';

export const OpenAPISpecification = {
  info: {
    title: 'New API generated with compeller',
    version: '1.0.0',
  },
  openapi: '3.1.0',
  paths: {
    'v1/users/{id}': {
      post: {
        parameters: [
          {
            name: 'id',
            in: 'path',
            description: 'user id to lookup',
            required: true,
            schema: {
              type: 'number',
            } as const,
          } as const,
          {
            name: 'tags',
            in: 'query',
            description: 'tags to filter by',
            required: false,
            style: 'form',
            schema: {
              type: 'array',
              items: {
                type: 'string',
              },
            } as const,
          } as const,
          {
            name: 'limit',
            in: 'query',
            description: 'maximum number of results to return',
            required: false,
            schema: {
              type: 'integer',
              format: 'int32',
            },
          } as const,
        ] as const,
        responses: {
          '201': {
            description: 'Get the current API version',
            headers: {
              'x-rate-limit': {
                description:
                  'The number of allowed requests in the current period',
                schema: {
                  type: 'number',
                } as const,
              },
              'x-request-id': {
                description: 'The unique request id header',
                schema: {
                  type: 'string',
                } as const,
              },
            },
            content: {
              'application/json': {
                schema: {
                  type: 'object',
                  required: ['version'],
                  additionalProperties: false,
                  properties: {
                    version: {
                      type: 'string',
                    },
                  },
                } as const,
              },
            },
          },
        },
      },
    },
  },
};