event-handler/event-handler-openapi.yaml at master · pgeadas/event-handler · 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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
openapi: 3.0.3
info:
  title: Event Handler App
  version: 0.0.1

servers:
  - url: http://localhost:8000

paths:
  /events:
    get:
      summary: This endpoint allows for querying our server using pagination.
      parameters:
        - name: pageNumber
          in: query
          schema:
            type: integer
            minimum: 1
          required: true
          description: "the number of the page where to start fetching data"

        - name: itemCount
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
          required: true
          description: "the number of items per page"

        - name: orderBy
          in: query
          schema:
            type: string
            pattern: "[id|workspaceId|userId|cpu|mem|io],+"
            items:
              type: string
              enum:
                - id
                - workspaceId
                - userId
                - cpu
                - mem
                - io
          required: false
          description: "A list of column names delimited by comma"

        - name: sort
          in: query
          schema:
            type: string
            pattern: "[asc|desc],+"
            items:
              type: string
              default: asc
              enum:
                - asc
                - desc
          required: false
          description: "A list of sorting directions delimited by comma, that will match the list of orderBy columns.
          Can be left empty, in which case the default will be used"
      responses:
        200:
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: "#/components/schemas/Event"
        400:
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        500:
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string

components:
  schemas:
    Event:
      type: object
      required:
        - id
        - userId
        - workspaceId
        - cpu
        - mem
        - io
      properties:
        id:
          type: string
        userId:
          type: string
        workspaceId:
          type: string
        cpu:
          type: number
        mem:
          type: number
        io:
          type: number