-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathopenapi.json
More file actions
125 lines (125 loc) · 3 KB
/
Copy pathopenapi.json
File metadata and controls
125 lines (125 loc) · 3 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
{
"openapi": "3.0.0",
"info": {
"title": "Store API",
"version": "1.0.0",
"description": "A small API used to demonstrate root-config filtering."
},
"paths": {
"/users": {
"get": {
"operationId": "listUsers",
"summary": "List users",
"responses": {
"200": {
"description": "A list of users",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {"$ref": "#/components/schemas/User"}
}
}
}
}
}
}
},
"/users/{id}/audit": {
"get": {
"operationId": "getUserAudit",
"summary": "Internal audit log for a user",
"parameters": [
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
],
"responses": {
"200": {
"description": "Audit entries",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {"$ref": "#/components/schemas/AuditEntry"}
}
}
}
}
}
}
},
"/orders": {
"get": {
"operationId": "listOrders",
"summary": "List orders",
"responses": {
"200": {
"description": "A list of orders",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {"$ref": "#/components/schemas/Order"}
}
}
}
}
}
}
},
"/metrics": {
"get": {
"operationId": "getMetrics",
"summary": "Operational metrics (not part of the public SDK)",
"responses": {
"200": {
"description": "Metrics",
"content": {
"application/json": {
"schema": {"$ref": "#/components/schemas/Metrics"}
}
}
}
}
}
}
},
"components": {
"schemas": {
"User": {
"type": "object",
"properties": {
"id": {"type": "string"},
"displayName": {"type": "string"},
"address": {"$ref": "#/components/schemas/Address"}
}
},
"Address": {
"type": "object",
"properties": {
"street": {"type": "string"},
"city": {"type": "string"}
}
},
"AuditEntry": {
"type": "object",
"properties": {
"action": {"type": "string"},
"at": {"type": "string", "format": "date-time"}
}
},
"Order": {
"type": "object",
"properties": {
"id": {"type": "string"},
"total": {"type": "number"}
}
},
"Metrics": {
"type": "object",
"properties": {
"uptimeSeconds": {"type": "number"}
}
}
}
}
}