This repository has been archived by the owner on Jul 17, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi-docs.json
182 lines (182 loc) · 5.69 KB
/
api-docs.json
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
{
"definitions": {
"context": {
"properties": {
"graph": {
"description": "graph type (LIE, PIE, GAUGE)",
"type": "string"
},
"interval": {
"description": "time interval to capture the metric",
"type": "string"
},
"kpiId": {
"description": "KPI ID (if topic is related to a KPI)",
"type": "string"
},
"metricCollectionType": {
"description": "metric collection type (if topic is related to a metric)",
"type": "string"
},
"metricId": {
"description": "metric ID (if topic is related to a metric)",
"type": "string"
},
"name": {
"description": "metric name",
"type": "string"
},
"unit": {
"description": "metric unit",
"type": "string"
}
}
},
"record": {
"properties": {
"value": {
"$ref": "#/definitions/value",
"description": "value included in the records list"
}
}
},
"signalling_topic_data": {
"properties": {
"expId": {
"description": "expId set to 'internal'",
"type": "string"
},
"topic": {
"description": "signalling topic name",
"type": "string"
}
}
},
"value": {
"properties": {
"action": {
"description": "either subscribe or unsubscribe",
"type": "string"
},
"context": {
"$ref": "#/definitions/context",
"description": "additional information"
},
"expId": {
"description": "experiment ID",
"type": "string"
},
"topic": {
"description": "topic name",
"type": "string"
}
}
}
},
"info": {
"title": "DCM REST API",
"version": "1.0"
},
"paths": {
"/": {
"get": {
"description": "",
"responses": {
"200": {
"description": "OK"
}
},
"summary": "Get status."
}
},
"/dcm/publish/{topic}": {
"post": {
"description": "",
"parameters": [
{
"description": "topic name",
"in": "path",
"name": "topic",
"type": "string"
},
{
"description": "records sent in the message",
"in": "body",
"items": {
"$ref": "#/definitions/record"
},
"name": "records",
"type": "array"
}
],
"responses": {
"201": {
"description": "accepted request"
},
"400": {
"description": "error processing the request"
}
},
"summary": "Publish data in a topic."
}
},
"/dcm/subscribe": {
"post": {
"description": "",
"parameters": [
{
"in": "body",
"name": "signalling_topic_data",
"schema": {
"$ref": "#/definitions/signalling_topic_data"
}
}
],
"responses": {
"201": {
"description": "accepted request"
},
"400": {
"description": "error processing the request"
}
},
"summary": "Subscribe to signalling topic."
}
},
"/dcm/unsubscribe": {
"delete": {
"description": "",
"parameters": [
{
"in": "body",
"name": "signalling_topic_data",
"schema": {
"$ref": "#/definitions/signalling_topic_data"
}
}
],
"responses": {
"201": {
"description": "accepted request"
},
"400": {
"description": "error processing the request"
}
},
"summary": "Unsubscribe to signalling topic."
}
},
"/spec": {
"get": {
"description": "",
"responses": {
"swagger": {
"description": "swagger specification"
}
},
"summary": "Get swagger specification."
}
}
},
"swagger": "2.0"
}