-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapidesign.json
More file actions
141 lines (140 loc) · 3.53 KB
/
openapidesign.json
File metadata and controls
141 lines (140 loc) · 3.53 KB
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
{
"openapi": "3.0.0",
"info": {
"title": "Customer Management API",
"version": "1.0.0",
"description": "API for managing customers in a customer management system"
},
"paths": {
"/customers": {
"get": {
"summary": "Get information on all customers",
"responses": {
"200": {
"description": "List of customers",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Customer"
}
}
}
}
}
}
}
},
"/customers/{id}": {
"get": {
"summary": "Get information on a specific customer",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Information on the specific customer",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
}
}
}
}
}
},
"put": {
"summary": "Modify an existing customer",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"description": "Updated customer information",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
}
}
}
},
"responses": {
"200": {
"description": "Customer modified successfully"
}
}
},
"delete": {
"summary": "Delete a specific customer",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Customer deleted successfully"
}
}
}
}
},
"components": {
"schemas": {
"Customer": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"companyName": {
"type": "string"
},
"companyAddress": {
"type": "string"
},
"contactPerson": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"email": {
"type": "string"
},
"role": {
"type": "string"
}
},
"required": ["name", "phoneNumber", "email", "role"]
}
},
"required": ["id", "companyName", "companyAddress", "contactPerson"]
}
}
}
}