Newer
Older
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
"description": "Set by FAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.",
"type": "uri"
},
"requestWebsocketUri": {
"description": "Set to true by the service consumer to indicate that Websocket delivery is requested.",
"type": "boolean"
}
}
},
"OnuAlarmSubscription": {
"properties": {
"_links": {
"$ref": "#/components/schemas/OnuAlarmSubscription.links"
},
"callbackReference": {
"description": "URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "URI"
},
"requestTestNotification": {
"description": "Shall be set to TRUE by the service consumer to request",
"type": "boolean"
"websockNotifConfig": {
"description": "Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
"$ref": "#/components/schemas/WebsockNotifConfig"
},
"expiryDeadline": {
"$ref": "#/components/schemas/TimeStamp"
},
"filterCriteriaOnuAlarm": {
"$ref": "#/components/schemas/OnuAlarmSubscription.filterCriteriaOnuAlarm"
},
"subscriptionType": {
"description": "Shall be set to \\\"OnuAlarmSubscription\\\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
"required": [
"subscriptionType",
"filterCriteriaOnuAlarm"
],
"type": "object",
"x-etsi-ref": "6.3.2"
},
"PonInfo.opticalNetworkInfo.dsRate": {
"description": "Downstream line rate, valid values are:\n1 =\t2,48832 Gbit/s: G-PON [i.9]; or\nNG-PON2 option 2 [i.8].\n2 =\t9,95328 Gbit/s: XG-PON [i.10]; or\n XGS-PON [i.11]; or\nNG-PON2 option 1 [i.8].",
"enum": [
1,
2
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"PonInfo.opticalNetworkInfo.operationalState": {
"description": "It reports whether the ONU is currently capable of performing its function. Valid values are: 0 = enabled 1 = disabled",
"enum": [
0,
1
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"PonInfo.opticalNetworkInfo.ponTech": {
"description": "An informative field identifying the optical technology used. The valid values are: 1 = GPON. 2 = XGPON.3 = NGPON2. 4 = XGSPON.",
"enum": [
1,
2,
3,
4
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"PonInfo.opticalNetworkInfo.usRate": {
"description": "Upstream line rate, valid values are:\n1 =\t1,24416 Gbit/s: G-PON option 1 [i.9].\n2 =\t2,48832 Gbit/s: G-PON option 2 [i.9]; or\nXG-PON [i.10]; or\nNG-PON2 option 2 [i.8].\n3 =\t9,95328 Gbit/s: XGS-PON [i.11]; or\nNG-PON2 option 1 [i.8].",
"enum": [
1,
2,
3
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"PonInfo": {
"properties": {
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
},
"customerPremisesInfo": {
"description": "The physical location of a customer site.",
"items": {
"$ref": "#/components/schemas/CpInfo"
},
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "CpInfo"
},
"ponSYS_ID": {
"description": "The 20-bit identity of the optical system within a certain domain.This is a reference value set by the OSS.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"onuId": {
"description": "Information to identify an Optical Network Unit.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"ponTech": {
"$ref": "#/components/schemas/PonInfo.opticalNetworkInfo.ponTech"
},
"operationalState": {
"$ref": "#/components/schemas/PonInfo.opticalNetworkInfo.operationalState"
},
"dsRate": {
"$ref": "#/components/schemas/PonInfo.opticalNetworkInfo.dsRate"
},
"usRate": {
"$ref": "#/components/schemas/PonInfo.opticalNetworkInfo.usRate"
}
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
"required": [
"customerPremisesInfo",
"ponSYS_ID",
"opticalNetworkInfo",
"onuId",
"ponTech",
"operationalState",
"dsRate",
"usRate"
],
"type": "object",
"x-etsi-ref": "6.2.5"
},
"SubscriptionLinkList.links.subscription.subscriptionType": {
"description": "Type of the subscription. The string shall be set according to the \"subscriptionType\" attribute of the associated subscription data type defined in clauses 6.3.2, 6.3.3, 6.3.4 and 6.3.6 \"OnuAlarmSubscription\" \"DevInfoSubscription\" \"CmConnSubscription\" \"AniAlarmSubscription\"",
"enum": [
"OnuAlarmSubscription",
"DevInfoSubscription",
"CmConnSubscription",
"AniAlarmSubscription\""
],
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"SubscriptionLinkList.links.subscription": {
"properties": {
"href": {
"description": "The URI referring to the subscription.",
"format": "uri",
"type": "uri",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "URI"
"subscriptionType": {
"$ref": "#/components/schemas/SubscriptionLinkList.links.subscription.subscriptionType"
}
"required": [
"href",
"subscriptionType"
]
},
"SubscriptionLinkList.links": {
"description": "Hyperlinks related to the resource.",
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
},
"subscriptions": {
"description": "The service consumer's subscriptions.",
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionLinkList.links.subscription"
}
},
"SubscriptionLinkList": {
"properties": {
"_links": {
"$ref": "#/components/schemas/SubscriptionLinkList.links"
}
"required": [
"_links"
],
"type": "object",
"x-etsi-ref": "6.3.5"
},
"TestNotification": {
"type": "object",
"required": [
"notificationType",
"_links"
],
"properties": {
"notificationType": {
"description": "Shall be set to \"TestNotification",
"type": "string"
"_links": {
"description": "Hyperlink related to the resource.",
"type": "object",
"required": [
"subscription"
],
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
}
}
}
},
"TimeStamp": {
"properties": {
"nanoSeconds": {
"description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
"format": "Uint32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
"seconds": {
"description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.",
"format": "Uint32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
}
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
"required": [
"seconds",
"nanoSeconds"
],
"type": "object",
"x-etsi-ref": "6.5.2"
},
"TraceRouteDiagnostics.diagnosticsState": {
"description": "The state of the IP trace-route test. Enumeration of: 1 = None. 2 = Requested. 3 = Complete. 4 = Error_CannotResolveHostName. 5 = Error_MaxHopCountExceeded. 6 = Error_Internal. 7 = Error_Other.",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"TraceRouteDiagnostics": {
"properties": {
"dataBlockSize": {
"description": "Size of the data block in bytes to be sent for each trace route.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
"diagnosticsState": {
"$ref": "#/components/schemas/TraceRouteDiagnostics.diagnosticsState"
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
"host": {
"description": "Host name or address of the host to find a route to.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"maxHopCount": {
"description": "The maximum number of hop used in outgoing probe packets. The default is 30 hops.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"numberOfRouteHops": {
"description": "Result parameter indicating the number of hops within the discovered route.\n\nIf a route could not be determined, this value shall be zero.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"responseTime": {
"description": "Result parameter indicating the response time in milliseconds the most recent trace route test.\n\nIf a route could not be determined, this value shall be zero.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"timeout": {
"description": "Timeout in milliseconds for the trace route test.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
"required": [
"diagnosticsState"
],
"type": "object",
"x-etsi-ref": "6.5.5"
},
"UploadDiagnostics.diagnosticsState": {
"description": "The state of the HTTP and FTP download test. Enumeration of: 1 = None. 2 = Requested. 3 = Completed. 4 = Error_InitConnectionFailed. 5 = Error_NoResponse. 6 = Error_PasswordRequestFailed. 7 = Error_LoginFailed. 8 = Error_NoTransferMode. 9 = Error_NoPASV. 10 = Error_NoCWD. 11 = Error_NoSTOR.12 = Error_NoTransferComplete.",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"UploadDiagnostics": {
"properties": {
"bOMTime": {
"$ref": "#/components/schemas/TimeStamp"
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
"diagnosticsState": {
"$ref": "#/components/schemas/UploadDiagnostics.diagnosticsState"
},
"eOMTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"rOMTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"tCPOpenReponseTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"tCPOpenRequestTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"testBytesSent": {
"description": "The test traffic sent in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between bOMTime and eOMTime.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"testFileLength": {
"description": "The size of the file (in bytes) to be uploaded to the\nserver.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"uploadURI": {
"description": "The URI for the device to perform the upload to.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "URI"
}
},
"required": [
"diagnosticsState"
],
"type": "object",
"x-etsi-ref": "6.5.7"
},
"LinkType": {
"description": "'URI referring to a resource'",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"$ref": "#/components/schemas/Href"
}
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
"Href": {
"description": "The URI referring to the subscription.",
"type": "string",
"format": "uri"
},
"ProblemDetails": {
"properties": {
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "URI"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem",
"format": "uint32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"title": {
"description": "A short, human-readable summary of the problem type",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"type": {
"description": "A URI reference according to IETF RFC 3986 that identifies the problem type",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "URI"
}
"type": "object"
}
},
"responses": {
"204": {
"description": "No Content"
},
"206": {
"description": "Partial content"
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"409": {
"description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"412": {
"description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"415": {
"description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"422": {
"description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"