backend-api/docs.yaml at main · EsCore-Team/backend-api · 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
183
openapi: 3.0.1
info:
  title: Escore API Docs
  description: API for support mobile app environtment and machine learning model.
  version: 1.0.0
servers:
  - url: https://escore-app.et.r.appspot.com
    description: Production server
  - url: http://localhost:8000
    description: Local server
paths:
  /api/register:
    post:
      summary: For user register
      tags:
        - Authentication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                fullName:
                  type: string
                  example: Abdul Rojak
                email:
                  type: string
                  example: abdul123@gmail.com
                password:
                  type: string
                  example: abdulgntg
      responses:
        '201':
          description: User registered successfully!
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: boolean
                    example: false
                  message:
                    type: string
        '500':
          description: Internal server error!
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: boolean
                    example: true
                  message:
                    type: string


  /api/login:
    post:
      summary: For user login
      tags:
        - Authentication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  example: abdul@gmail.com
                password:
                  type: string
                  example: abdulgntg
      responses:
        '200':
          description: Success logged in!
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: boolean
                    example: false
                  message:
                    type: string
                  loginResult:
                    type: object
                    properties:
                      userId:
                        type: string
                      email:
                        type: string
                      fullName:
                        type: string
                      token:
                        type: string
        '500':
          description: Internal server error!
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: boolean
                    example: true
                  message:
                    type: string


  /api/history/{email}:
    get:
      summary: For history predictions
      tags:
        - Model Prediction
      parameters:
        - name: email
          in: path
          required: true
          schema:
            type: string
            format: email
      responses:
        '200':
          description: History predictions retrieved successfully!
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: boolean
                    example: false
                  message:
                    type: string
                  email:
                    type: string
                  predictions:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        title:
                          type: string
                        essay:
                          type: string
                        createdAt:
                          type: string
                          format: date-time
                        predicted_result:
                          type: object
                          properties:
                            score:
                              type: string
                            suggestion:
                              type: string
        '500':
          description: Internal server error!
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: boolean
                    example: true
                  message:
                    type: string


# components:
#   securitySchemes:
#     bearerAuth:
#       type: http
#       scheme: bearer
#       bearerFormat: JWT