code-vs-code/swagger.yml at master · ut-code/code-vs-code · 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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
openapi: 3.0.3
info:
  title: Code vs Code
  version: 1.0.0
servers:
  - url: https://utcode.net/code-vs-code
paths:
  /user:
    get:
      tags:
        - user
      summary: Get all users
      responses:
        '200':
          description: array of user objects
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
    put:
      tags:
        - user
      summary: Change user name
      parameters:
        - name: Id
          in: query
          description: user ID
          required: true
          schema:
            type: integer
      requestBody:
        description: new user name
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
      responses:
        '200':
          description: successful operation
    post:
      tags:
        - user
      summary: Create user
      parameters: []
      requestBody:
        description: user name
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
      responses:
        '200':
          description: user object
          content:
            application/json:
              schema:
                  $ref: '#/components/schemas/User'
  /user/{userId}:
    get:
      tags:
        - user
      summary: Get user by ID
      parameters:
        - name: userId
          in: path
          description: user ID
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: user object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
  /program:
    put:
      tags:
        - program
      summary: Upload program
      parameters: []
      requestBody:
        description: userID and program
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Program'
      responses:
        '200':
          description: successful operation
  /swap-rank:
    post:
      tags:
        - projector
      summary: Swap ranks of two users
      parameters: []
      requestBody:
        description: two userID
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SwapRank'
      responses:
        '200':
          description: successful operation
  /check-password:
    post:
      tags:
        - authorization
      summary: Check whether the password is correct
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [password]
              properties:
                password:
                  type: string
      responses:
        '200':
          description: successful operation
components:
  schemas:
    User:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
        rank:
          type: integer
        code:
          type: string
    Program:
      type: object
      required:
        - userId
        - code
      properties:
        userId:
          type: integer
        code:
          type: string
    SwapRank:
      type: object
      required:
        - userId1
        - userId2
      properties:
        userId1:
          type: integer
        userId2:
          type: integer