Microservices/swaggerDocumentation.yaml at develop · wpasc/Microservices · 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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
swagger: '2.0'
info:
  description: >-
    This is a Person and Address api tool.     Application code on our
    [repo](https://github.com/WillPascucci/Microservices)
  version: 1.0.0
  title: Teapot Project 1 Part 1
  termsOfService: 'http://swagger.io/terms/'
  contact:
    email: apiteam@swagger.io
  license:
    name: Apache 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
host: petstore.swagger.io
basePath: /v2
tags:
  - name: person
    description: Everything about people
    externalDocs:
      description: Find out more
      url: 'http://swagger.io'
  - name: address
    description: Everything about addresses
schemes:
  - http
paths:
  /person:
    get:
      tags:
        - person
      summary: Get information about persons in the database
      description: ''
      operationId: person
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          description: Person object that needs to be added to the database
          schema:
            $ref: '#/definitions/Person'
      responses:
        '405':
          description: Invalid input
          schema:
            $ref: '#/definitions/Person'
      security: []
    post:
      tags:
        - person
      summary: Add a person
      description: ''
      operationId: addPerson
      parameters:
        - in: body
          name: body
          description: Person object that needs to be added to the database
          schema:
            $ref: '#/definitions/Person'
      responses:
        '405':
          description: Invalid input
      security: []
  '/person/{id}':
    get:
      tags:
        - person
      summary: Get a person
      description: ''
      operationId: getPerson
      produces:
        - application/json
      parameters:
        - name: id
          in: path
          description: ID of pet to update
          required: true
          type: integer
          format: int64
      responses:
        '405':
          description: Invalid input
      security: []
    put:
      tags:
        - person
      summary: Update a person
      description: ''
      operationId: a43dd2321Pet
      consumes:
        - application/json
        - application/xml
      produces:
        - application/xml
        - application/json
      parameters:
        - in: body
          name: body
          description: Pet object that needs to be added to the store
          required: true
          schema:
            $ref: '#/definitions/Person'
      responses:
        '405':
          description: Invalid input
      security: []
    delete:
      tags:
        - person
      summary: Delete a person
      description: ''
      operationId: add1235Pet
      consumes:
        - application/json
        - application/xml
      produces:
        - application/xml
        - application/json
      parameters:
        - in: body
          name: body
          description: Pet object that needs to be added to the store
          required: true
          schema:
            $ref: '#/definitions/Person'
      responses:
        '405':
          description: Invalid input
      security: []
  '/person/{id}/address':
    get:
      tags:
        - person
      summary: Returns the person's address information
      description: ''
      operationId: addPet987979
      consumes:
        - application/json
        - application/xml
      produces:
        - application/xml
        - application/json
      parameters:
        - name: id
          in: path
          description: ID of pet to update
          required: true
          type: integer
          format: int64
      responses:
        '405':
          description: Invalid input
      security: []
  /address:
    get:
      tags:
        - address
      summary: Get information about addresses in the database
      description: ''
      operationId: address
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          description: Pet object that needs to be added to the store
          required: true
          schema:
            $ref: '#/definitions/Address'
      responses:
        '405':
          description: Invalid input
      security: []
    post:
      tags:
        - address
      summary: Add an address
      description: ''
      operationId: addAddress
      consumes:
        - application/json
        - application/xml
      produces:
        - application/xml
        - application/json
      parameters:
        - in: body
          name: body
          description: Pet object that needs to be added to the store
          required: true
          schema:
            $ref: '#/definitions/Address'
      responses:
        '405':
          description: Invalid input
      security: []
  '/address/{id}':
    get:
      tags:
        - address
      summary: Get an address
      description: ''
      operationId: getAddress
      consumes:
        - application/json
        - application/xml
      produces:
        - application/xml
        - application/json
      parameters:
        - name: id
          in: path
          description: ID of address to get
          required: true
          type: integer
          format: int64
      responses:
        '405':
          description: Invalid input
      security: []
    put:
      tags:
        - address
      summary: Update address
      description: ''
      operationId: updateAddress
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          description: Pet object that needs to be added to the store
          required: true
          schema:
            $ref: '#/definitions/Address'
      responses:
        '405':
          description: Invalid input
      security: []
    delete:
      tags:
        - address
      summary: Delete an address
      description: ''
      operationId: addPet
      consumes:
        - application/json
        - application/xml
      produces:
        - application/xml
        - application/json
      parameters:
        - in: body
          name: body
          description: Pet object that needs to be added to the store
          required: true
          schema:
            $ref: '#/definitions/Address'
      responses:
        '405':
          description: Invalid input
      security: []
  '/address/{id}/persons':
    get:
      tags:
        - address
      summary: Returns persons with specified address
      description: ''
      operationId: getAddressPerson
      consumes:
        - application/json
        - application/xml
      produces:
        - application/xml
        - application/json
      parameters:
        - in: body
          name: body
          description: Pet object that needs to be added to the store
          required: true
          schema:
            $ref: '#/definitions/Address'
      responses:
        '405':
          description: Invalid input
      security: []
definitions:
  Person:
    type: object
    properties:
      id:
        type: integer
      firstname:
        type: string
      age:
        type: integer
      phone:
        type: string
      addressUuid:
        type: string
  Address:
    type: object
    properties:
      streetname:
        type: string
      city:
        type: string
      state:
        type: string
      zip:
        type: integer
      uuid:
        type: string
externalDocs:
  description: Find out more about Swagger
  url: 'http://swagger.io'