-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathInterfaces.Physical.Network.WAN.json
331 lines (331 loc) · 14.1 KB
/
Interfaces.Physical.Network.WAN.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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
{
"paths": {
"Interfaces.Physical.Network.WAN.List": {
"operationId": "Interfaces.Physical.Network.WAN.List",
"summary": "Retrieves a list of WAN Interfaces.",
"tags": [
"Interfaces.Physical.Network.WAN"
],
"responses": {
"ARGUMENT_DATA_TYPE_MISMATCH": {
"description": "A call attempt to a valid object and procedure was performed, however an argument value was provided with an unexpected data type, therefore it was not possible to process the request.",
"raised_by": "Micro-Service",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"ARGUMENT_DATA_TYPE_MISMATCH\", \"Description\": \"Unable to process the request because the value provided on the \\u2018Enabled\\u2019 field is not a valid Boolean.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"ARGUMENT_NOT_FOUND": {
"description": "A call to a valid object and procedure was performed, however an unrecognized argument was provided, therefore it was not possible to process the request.",
"raised_by": "Micro-Service",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"ARGUMENT_NOT_FOUND\", \"Description\": \"Unable to process the request because 'Enabled' is not a valid argument.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"ARGUMENT_REQUIRED_MISSING": {
"description": "A call to a valid object and procedure was performed, however a required argument was not provided, therefore it was not possible to process the request.",
"raised_by": "Micro-Service",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"ARGUMENT_REQUIRED_MISSING\", \"Description\": \"Unable to process the request because the 'Enabled' field was not provided.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"ARGUMENT_VALUE_NOT_SUPPORTED": {
"description": "A call attempt to a valid object and procedure was performed, however a non-supported argument value was provided, therefore it was not possible to process the request.",
"raised_by": "Micro-Service",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"ARGUMENT_VALUE_NOT_SUPPORTED\", \"Description\": \"Unable to process the request because \\u2018Red\\u2019 is not a value supported by the \\u2018Colour\\u2019 field.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"METHOD_NOT_FOUND": {
"description": "A call to a valid object but non-existing procedure was performed, therefore it was not possible to process the request.",
"raised_by": "IPC Bus",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"METHOD_NOT_FOUND\", \"Description\": \"Unable to process the request because 'Set' is not a valid method\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"OBJECT_NOT_FOUND": {
"description": "A call to a non-existing object was performed, therefore it was not possible to process the request.",
"raised_by": "IPC Bus",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"OBJECT_NOT_FOUND\", \"Description\": \"Unable to process the request because 'prpl.Dummy' is not a valid object.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"OK": {
"description": "A well-formed request to an authorized resource was performed, and the receiver was able to compute the response within the allowed time-window.",
"raised_by": "Micro-Service",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"OK\"}, \"Body\": {\"List\": [{\"Id\": \"DOCSIS\", \"Name\": \"DOCSIS\", \"Enabled\": true, \"Mode\": [\"DOCSIS 3.1\", \"DOCSIS 3.0\"], \"Status\": {\"State\": \"Active\", \"Protocol\": \"DOCSIS 3.1\", \"SyncSpeed\": {\"Downstream\": 80000000, \"Upstream\": 40000000}, \"SignalNoiseRatio\": 20, \"Uptime\": 3600}, \"Statistics\": {\"Frames\": {\"Transmitted\": 0, \"Received\": 0}, \"Bytes\": {\"Transmitted\": 0, \"Received\": 0}}}], \"Limit\": 10, \"Offset\": 0}}",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Response"
},
{
"properties": {
"Body": {
"properties": {
"Limit": {
"type": "Integer",
"description": "WAN Interface maximum number of returned entries.",
"format": "-",
"default_value": "0",
"possible_values": "\"0\" to fetch all entries or positive integer"
},
"List": {
"type": "List",
"description": "WAN Interface list of entries.",
"format": "-",
"default_value": "-",
"possible_values": "-",
"readOnly": true
},
"Offset": {
"type": "Integer",
"description": "WAN Interface list start offset.",
"format": "-",
"default_value": "0",
"possible_values": "\"0\" to fetch all entries or positive integer"
}
},
"required": []
}
}
}
]
}
}
}
},
"OPERATION_ALREADY_IN_PROGRESS": {
"description": "A well-formed request to an authorized resource was performed, however the operation could not be completed, as the required resource was temporarily locked by a different request in progress.",
"raised_by": "Micro-Service",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"OPERATION_ALREADY_IN_PROGRESS\", \"Description\": \"Unable to process the request because there is a duplicate operation currently in progress.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"OPERATION_ERROR": {
"description": "A well-formed request was performed however, it was not possible to process the request due to an unknown internal error.",
"raised_by": "Micro-Service",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"OPERATION_ERROR\", \"Description\": \"Unable to process the request because there is a configuration error.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"OPERATION_ILLEGAL": {
"description": "A well-formed request to an authorized resource was performed, however the operation could not be completed, as it was invoked in the incorrect system state or order.",
"raised_by": "Micro-Service",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"OPERATION_ILLEGAL\", \"Description\": \"Unable to process the request because the 'Stop' procedure can only be invoked after the 'Start' method has been called.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"OPERATION_PERMISSION_DENIED": {
"description": "A well-formed request was performed however, the client did not meet the security conditions required to access the protected resource, therefore it is not possible to process the request.",
"raised_by": "IPC Bus / Remote Protocol Adapter",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"OPERATION_PERMISSION_DENIED\", \"Description\": \"Unable to process the request because user \\u2018Admin\\u2019 does not have access privileges to invoke the \\u2018Set\\u2019 procedure on object \\u2018prpl.Dummy\\u2019.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"OPERATION_TIMEOUT": {
"description": "A well-formed request was performed however, it was not possible to process the response within the allowed time-frame.",
"raised_by": "Micro-Service",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"OPERATION_TIMEOUT\", \"Description\": \"The operation has been aborted because the service did not respond within the expected 5 seconds time-frame.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"Limit": {
"type": "Integer",
"description": "WAN Interface maximum number of returned entries.",
"format": "-",
"default_value": "0",
"possible_values": "\"0\" to fetch all entries or positive integer"
},
"Offset": {
"type": "Integer",
"description": "WAN Interface list start offset.",
"format": "-",
"default_value": "0",
"possible_values": "\"0\" to fetch all entries or positive integer"
}
},
"required": []
},
"example": "{\"Limit\": 10, \"Offset\": 0}"
}
}
}
}
},
"components": {
"schemas": {
"ListRequest": {
"properties": {
"Limit": {
"description": "How many items to return at one time (max 200)",
"required": false,
"type": "integer",
"schema": {
"type": "integer",
"format": "int32",
"default": 20,
"example": {
"Limit": 10
}
}
},
"Offset": {
"description": "Which object index to start with",
"required": false,
"type": "integer",
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"example": {
"Offset": 45
}
}
}
}
},
"Response": {
"type": "object",
"description": "schema for a responses to object methods",
"oneOf": [
{
"properties": {
"Header": {
"type": "object",
"description": "Header object specifying the name of the response type and providing a detailed description in case of an error",
"properties": {
"Name": {
"type": "string",
"description": "name of the response type",
"enum": [
"OK"
]
}
},
"required": [
"Name"
],
"additionalProperties": false
},
"Body": {
"type": "object"
}
},
"additionalProperties": false
},
{
"properties": {
"Header": {
"type": "object",
"description": "Header object specifying the name of the response type and providing a detailed description in case of an error",
"properties": {
"Name": {
"type": "string",
"description": "name of the response type",
"enum": [
"OK",
"OPERATION_ALREADY_IN_PROGRESS",
"ARGUMENT_NOT_FOUND",
"ARGUMENT_DATA_TYPE_MISMATCH",
"OPERATION_TIMEOUT",
"METHOD_NOT_FOUND",
"OPERATION_ILLEGAL",
"OBJECT_NOT_FOUND",
"ARGUMENT_REQUIRED_MISSING",
"OPERATION_ERROR",
"ARGUMENT_VALUE_NOT_SUPPORTED",
"OPERATION_PERMISSION_DENIED"
]
},
"Description": {
"type": "string",
"description": "A more detailed error message. NOTE: only filled in when the operation returns an error."
}
},
"required": [
"Name",
"Description"
],
"additionalProperties": false
}
},
"additionalProperties": false
}
]
},
"Interfaces.Physical.Network.WAN": {
"description": "Interfaces.Physical.Network.WAN Object",
"id": "Interfaces.Physical.Network.WAN",
"type": "object",
"required": [],
"properties": {},
"events": {},
"example": {},
"layer": 3
}
}
}
}