sejutacita-test/swagger.yaml at master · bungambohlah/sejutacita-test · 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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
tags:
- name: users
  description: users API
- name: user_auth
  description: user authentications API

paths:
# [POST] User sign up
  /signup:
    post:
      tags:
      - user_auth
      summary: Signup a user
      description: Signup a user
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: body
        in: body
        description: User object
        required: true
        schema:
          $ref: '#/definitions/users'
      responses:
        200:
          description: User object
          schema:
            $ref: '#/definitions/users'
        400:
          description: Bad request
        500:
          description: Internal server error

# [POST] User login
  /login:
    post:
      tags:
      - user_auth
      summary: Login a authentication
      description: Login a authentication
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: body
        in: body
        description: User object
        required: true
        schema:
          $ref: '#/definitions/users'
      security: []
      responses:
        200:
          description: User object. The session ID is returned in a cookie named `Authorization`. You need to include this cookie in subsequent requests.
          headers:
            Set-Cookie:
              schema:
                type: string
                example: Authorization=abcde12345; Path=/; HttpOnly
          schema:
            $ref: '#/definitions/users'
        400:
          description: Bad request
        500:
          description: Internal server error

# [POST] User logout
  /logout:
    post:
      tags:
      - user_auth
      summary: Logout a authenticated user
      description: Logout a authenticated user
      produces:
      - application/json
      responses:
        200:
          description: User object
          schema:
            $ref: '#/definitions/users'
        400:
          description: Bad request
        500:
          description: Internal server error

# [GET] users
  /users:
    get:
      tags:
      - users
      summary: Find All Users
      security:
        - cookieAuth: []
      responses:
        200:
          description: 'OK'
        500:
          description: 'Server Error'

# [POST] users
    post:
      tags:
      - users
      summary: Add User
      parameters:
      - name: body
        in: body
        description: user Data
        required: true
        schema:
          $ref: '#/definitions/users'
      security:
        - cookieAuth: []
      responses:
        201:
          description: 'Created'
        400:
          description: 'Bad Request'
        409:
          description: 'Conflict'
        500:
          description: 'Server Error'

# [GET] users/id
  /users/{id}:
    get:
      tags:
      - users
      summary: Find User By Id
      parameters:
      - name: id
        in: path
        description: User Id
        required: true
        type: integer
      security:
        - cookieAuth: []
      responses:
        200:
          description: 'OK'
        409:
          description: 'Conflict'
        500:
          description: 'Server Error'

# [PUT] users/id
    put:
      tags:
      - users
      summary: Update User By Id
      parameters:
      - name: id
        in: path
        description: user Id
        required: true
        type: integer
      - name: body
        in: body
        description: user Data
        required: true
        schema:
          $ref: '#/definitions/users'
      security:
        - cookieAuth: []
      responses:
        200:
          description: 'OK'
        400:
          description: 'Bad Request'
        409:
          description: 'Conflict'
        500:
          description: 'Server Error'

# [DELETE] users/id
    delete:
      tags:
      - users
      summary: Delete User By Id
      parameters:
      - name: id
        in: path
        description: user Id
        required: true
        type: integer
      security:
        - cookieAuth: []
      responses:
        200:
          description: 'OK'
        409:
          description: 'Conflict'
        500:
          description: 'Server Error'

# definitions
definitions:
  users:
    type: object
    required:
        - username
        - password
    properties:
      username:
        type: string
        description: user Username
      password:
        type: string
        description: user Password

securityDefinitions:
  APIKeyHeader:
    type: apiKey
    in: cookie
    name: Authorization
    description: "Authorization JWT token"

schemes:
  - https
  - http