dev-interview-platform/openapi.yaml at main · owaisjunedi/dev-interview-platform · 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
174
175
176
177
178
179
180
181
182
openapi: 3.0.3
info:
  title: DevInterview API
  version: 1.0.0
  description: Backend API for Interview Platform
paths:
  /auth/login:
    post:
      summary: Login user
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                email: {type: string}
                password: {type: string}
      responses:
        '200':
          description: Returns User and Token
          content:
            application/json:
              schema:
                type: object
                properties:
                  user:
                    type: object
                    properties:
                      id: {type: string}
                      email: {type: string}
                      name: {type: string}
                      role: {type: string}
                  token: {type: string}

  /auth/signup:
    post:
      summary: Register new user
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                email: {type: string}
                password: {type: string}
                name: {type: string}
      responses:
        '200':
          description: Returns User and Token
          content:
            application/json:
              schema:
                type: object
                properties:
                  user:
                    type: object
                    properties:
                      id: {type: string}
                      email: {type: string}
                      name: {type: string}
                      role: {type: string}
                  token: {type: string}

  /sessions:
    get:
      summary: Get all sessions
      responses:
        '200':
          description: List of sessions
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Session'
    post:
      summary: Create new session
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                candidateName: {type: string}
                candidateEmail: {type: string}
                language: {type: string}
      responses:
        '201':
          description: Created session
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Session'

  /sessions/{id}:
    get:
      summary: Get session details
      parameters:
        - name: id
          in: path
          required: true
          schema: {type: string}
      responses:
        '200':
          description: Session details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Session'

  /sessions/{id}/terminate:
    post:
      summary: Terminate a session
      parameters:
        - name: id
          in: path
          required: true
          schema: {type: string}
      responses:
        '200':
          description: Session terminated

  /execute:
    post:
      summary: Execute code
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                code: {type: string}
                language: {type: string}
      responses:
        '200':
          description: Execution result
          content:
            application/json:
              schema:
                type: object
                properties:
                  output: {type: string}
                  error: {type: string}

  /resources/questions:
    get:
      summary: Get Top 10 Questions
      parameters:
        - name: language
          in: query
          schema: {type: string}
        - name: level
          in: query
          schema: {type: string}
      responses:
        '200':
          description: List of questions
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id: {type: string}
                    title: {type: string}
                    difficulty: {type: string}
                    category: {type: string}

components:
  schemas:
    Session:
      type: object
      properties:
        id: {type: string}
        candidateName: {type: string}
        candidateEmail: {type: string}
        date: {type: string}
        duration: {type: integer}
        score: {type: integer, nullable: true}
        status: {type: string}
        language: {type: string}