-
Notifications
You must be signed in to change notification settings - Fork 0
/
OpenAPI.yaml
138 lines (138 loc) · 3.59 KB
/
OpenAPI.yaml
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
openapi: 3.0.3
info:
title: Simple Users API
description: A basic API collection for managing users
version: 1.0.0
contact: {}
servers:
- url: "https://postman-echo.com"
paths:
/:
get:
summary: Get User by ID
description:
operationId: get
parameters: []
responses:
200:
description: Success Response
content:
application/json:
schema:
type: object
example:
status: success
data:
id: 1
name: John Doe
email: [email protected]
age: 30
createdAt: "2024-01-01T00:00:00Z"
404:
description: User Not Found
content:
application/json:
schema:
type: object
example:
status: error
message: User not found
post:
summary: Create User
description: Create a new user with the provided information.
operationId: post
parameters: []
responses:
200:
description: Successful response
201:
description: Success Response
content:
application/json:
schema:
type: object
example:
status: success
data:
id: 1
name: John Doe
email: [email protected]
age: 30
createdAt: "2024-01-01T00:00:00Z"
400:
description: Validation Error
content:
application/json:
schema:
type: object
example:
status: error
errors:
name: Name is required
email: Invalid email format
age: Age must be a positive number
requestBody:
required: true
content:
application/json:
schema:
type: object
example:
name: John Doe
email: [email protected]
age: 30
put:
summary: Update User
description: Update an existing user's information.
operationId: put
parameters: []
responses:
200:
description: Success Response
content:
application/json:
schema:
type: object
example:
status: success
data:
id: 1
name: John Doe Updated
email: [email protected]
age: 31
updatedAt: "2024-01-02T00:00:00Z"
requestBody:
required: true
content:
application/json:
schema:
type: object
example:
name: John Doe Updated
email: [email protected]
age: 31
delete:
summary: Delete User
description:
operationId: delete
parameters: []
responses:
200:
description: Success Response
content:
application/json:
schema:
type: object
example:
status: success
message: User successfully deleted
components:
schemas: {}
securitySchemes:
basicAuth:
type: http
scheme: basic
digestAuth:
type: http
scheme: digest
tags: []