api-mc/api-users.yml at master · msalinas92/api-mc · 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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
swagger: '2.0'
info:
  description: REST API Multicaja
  version: '1.0'
  title: REST API
  termsOfService: Terms of service
  contact:
    name: Matías Salinas
    url: 'https://www.multicaja.cl'
    email: matias.salinas@multicaja.cl
  license:
    name: Apache License Version 2.0
    url: 'https://www.apache.org/licenses/LICENSE-2.0'
host: 'localhost:8085'
basePath: /
tags:
  - name: user-controller
    description: User Controller
paths:
  /user/:
    post:
      tags:
        - user-controller
      summary: Create user
      description: Send an object with the user information
      operationId: createUserUsingPOST
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: user
          description: user
          required: true
          schema:
            $ref: '#/definitions/User'
      responses:
        '200':
          description: Usuario creado correctamente
          schema:
            $ref: '#/definitions/Iterable'
        '201':
          description: Usuario creado correctamente
          schema:
            $ref: '#/definitions/Iterable'
        '401':
          description: No tienes permisos para realizar esta operación
        '403':
          description: No tienes permisos para acceder a este recurso
        '404':
          description: No se encontro la operación solicitada
    put:
      tags:
        - user-controller
      summary: Update user
      description: Send an object with the user information
      operationId: updateUserUsingPUT
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: user
          description: user
          required: true
          schema:
            $ref: '#/definitions/User'
      responses:
        '200':
          description: Usuario actualizado correctamente
          schema:
            $ref: '#/definitions/User'
        '201':
          description: Created
        '401':
          description: No tienes permisos para realizar esta operación
        '403':
          description: No tienes permisos para acceder a este recurso
        '404':
          description: No se encontro la operación solicitada
  '/user/{id}':
    delete:
      tags:
        - user-controller
      summary: Delete user
      description: Send the user id
      operationId: deteleUserUsingDELETE
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: id
          in: path
          description: id
          required: true
          type: integer
          format: int32
      responses:
        '200':
          description: Usuario eliminado correctamente
          schema:
            $ref: '#/definitions/User'
        '204':
          description: No Content
        '401':
          description: No tienes permisos para realizar esta operación
        '403':
          description: No tienes permisos para acceder a este recurso
        '404':
          description: No se encontro la operación solicitada
  '/user/{type}/{data}':
    get:
      tags:
        - user-controller
      summary: Get user
      description: 'type can be : rut/mail/phone and data should be the param from the selected option <br />Example: /user/rut/18083146'
      operationId: showUserUsingGET
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: type
          in: path
          description: type
          required: true
          type: string
        - name: data
          in: path
          description: data
          required: true
          type: string
      responses:
        '200':
          description: Operación exitosa
          schema:
            $ref: '#/definitions/User'
        '401':
          description: No tienes permisos para realizar esta operación
        '403':
          description: No tienes permisos para acceder a este recurso
        '404':
          description: No se encontro la operación solicitada
definitions:
  User:
    type: object
    properties:
      address:
        type: array
        items:
          $ref: '#/definitions/Address'
      banks:
        type: array
        items:
          $ref: '#/definitions/BankAccount'
      birthday:
        type: string
        format: date-time
      businessname:
        type: string
      created_at:
        type: string
        format: date-time
      dv:
        type: string
      email:
        type: string
      email_validated:
        type: boolean
      gender:
        type: string
      id:
        type: integer
        format: int64
      lastname:
        type: string
      name:
        type: string
      phone_number:
        type: integer
        format: int64
      phone_number_validated:
        type: boolean
      rut:
        type: integer
        format: int32
      rut_validated:
        type: boolean
      salt:
        type: string
      status:
        type: integer
        format: int32
      type:
        type: integer
        format: int32
      updated_at:
        type: string
        format: date-time
  Address:
    type: object
    properties:
      commune:
        type: string
      id:
        type: integer
        format: int64
      number:
        type: integer
        format: int32
      region:
        type: string
      street:
        type: string
  Iterable:
    type: object
  BankAccount:
    type: object
    properties:
      bank_code:
        type: string
      bank_name:
        type: string
      id:
        type: integer
        format: int64
      name_account:
        type: string
      number_account:
        type: string
      status:
        type: boolean
      type_account:
        type: integer
        format: int32