Skip to content

Commit 1cbdb7a

Browse files
committed
Add response examples to spec
1 parent f1e35ca commit 1cbdb7a

1 file changed

Lines changed: 42 additions & 20 deletions

File tree

modules/openapi-generator/src/test/resources/3_0/postman-collection/SampleProject.yaml

Lines changed: 42 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -156,15 +156,10 @@ paths:
156156
schema:
157157
$ref: '#/components/schemas/User'
158158
examples:
159-
Updated User Rebecca Baker:
160-
value:
161-
id: 13
162-
firstName: Rebecca
163-
lastName: Baker
164-
email: rebecca@gmail.com
165-
dateOfBirth: '1985-10-02'
166-
emailVerified: false
167-
createDate: '2019-08-24'
159+
success:
160+
$ref: '#/components/examples/response-success'
161+
anotherSuccess:
162+
$ref: '#/components/examples/another-response-success'
168163
'404':
169164
description: User Not Found
170165
'409':
@@ -188,17 +183,10 @@ paths:
188183
dateOfBirth:
189184
type: string
190185
examples:
191-
Update First Name:
192-
value:
193-
firstName: Rebecca
194-
Update Email:
195-
value:
196-
email: rebecca@gmail.com
197-
verified: true
198-
Update Last Name & Date of Birth:
199-
value:
200-
lastName: Baker
201-
dateOfBirth: '1985-10-02'
186+
success:
187+
$ref: '#/components/examples/patch-user'
188+
anotherSuccess:
189+
$ref: '#/components/examples/patch-user-2'
202190
description: Patch user properties to update.
203191
/user:
204192
post:
@@ -363,6 +351,40 @@ components:
363351
- user
364352
- admin
365353
- guest
354+
patch-user:
355+
summary: Example patch user
356+
value:
357+
firstName: John
358+
tags:
359+
- user
360+
patch-user-2:
361+
summary: Example patch another user
362+
value:
363+
firstName: Bill
364+
tags:
365+
- admin
366+
response-success:
367+
summary: Response 200
368+
value:
369+
id: 001
370+
firstName: Ron
371+
lastName: Edwardz
372+
email: ron.edwardz@example.com
373+
dateOfBirth: '1980-10-31'
374+
emailVerified: true
375+
tags:
376+
- admin
377+
another-response-success:
378+
summary: Another Response 200
379+
value:
380+
id: 002
381+
firstName: Rik
382+
lastName: Tom
383+
email: rik.tom@example.com
384+
dateOfBirth: '1981-10-11'
385+
emailVerified: true
386+
tags:
387+
- guest
366388
tags:
367389
- name: basic
368390
description: Basic tag

0 commit comments

Comments
 (0)