BwManagementApi.json 21.9 KB
Newer Older
1
{
Michel Roy's avatar
Michel Roy committed
2
  "openapi": "3.0.0",
3
  "info": {
Michel Roy's avatar
Michel Roy committed
4 5 6
    "contact": {
      "url": "https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api"
    },
Michel Roy's avatar
Michel Roy committed
7 8 9
    "title": "ETSI GS MEC 015 Bandwidth Management API",
    "version": "2.1.1",
    "description": "The ETSI MEC ISG Bandwidth Management API described using OpenAPI.",
10
    "license": {
ETSI CTI's avatar
ETSI CTI committed
11 12
      "name": "BSD-3-Clause",
      "url": "https://forge.etsi.org/legal-matters"
13 14 15
    }
  },
  "externalDocs": {
Michel Roy's avatar
Michel Roy committed
16 17
    "description": "ETSI GS MEC015 V2.1.1 Traffic Management APIs",
    "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/015/02.01.01_60/gs_MEC015v020101p.pdf"
18 19 20
  },
  "servers": [
    {
Michel Roy's avatar
Michel Roy committed
21 22 23 24 25 26
      "url": "https://localhost/bwm/v1"
    }
  ],
  "tags": [
    {
      "name": "bwm"
27 28 29 30 31
    }
  ],
  "paths": {
    "/bw_allocations": {
      "get": {
Michel Roy's avatar
Michel Roy committed
32
        "tags": [
Michel Roy's avatar
Michel Roy committed
33
          "bwm"
Michel Roy's avatar
Michel Roy committed
34 35 36 37
        ],
        "summary": "Retrieve information about a list of bandwidthAllocation resources",
        "description": "Retrieves information about a list of bandwidthAllocation resources. Typically used in 'Get configured bandwidth allocation from Bandwidth Management Service' procedure as described in clause 6.2.5.",
        "operationId": "bandwidthAllocationListGET",
38 39
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
40
            "$ref": "#/components/parameters/Query.app_instance_id"
41 42
          },
          {
Michel Roy's avatar
Michel Roy committed
43
            "$ref": "#/components/parameters/Query.app_name"
44 45
          },
          {
Michel Roy's avatar
Michel Roy committed
46
            "$ref": "#/components/parameters/Query.session_id"
47 48 49 50
          }
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
51 52 53 54
            "description": "Upon success, a response body containing an array of the bandwidthAllocations is returned.",
            "content": {
              "application/json": {
                "schema": {
Michel Roy's avatar
Michel Roy committed
55 56 57
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/BwInfo"
Michel Roy's avatar
Michel Roy committed
58 59 60 61
                  }
                }
              }
            }
62 63
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
64
            "$ref": "#/components/responses/400"
65 66
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
67
            "$ref": "#/components/responses/403"
68 69
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
70
            "$ref": "#/components/responses/404"
71 72 73 74 75
          }
        }
      },
      "post": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
76
          "bwm"
77
        ],
Michel Roy's avatar
Michel Roy committed
78 79 80 81 82 83 84 85 86 87
        "summary": "Create a bandwidthAllocation resource",
        "description": "Used to create a bandwidthAllocation resource. Typically used in 'Register to Bandwidth Management Service' procedure as described in clause 6.2.1.",
        "operationId": "bandwidthAllocationPOST",
        "parameters": [],
        "requestBody": {
          "description": "Entity body in the request contains BwInfo to be created.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
Michel Roy's avatar
Michel Roy committed
88
                "$ref": "#/components/schemas/BwInfo"
Michel Roy's avatar
Michel Roy committed
89 90 91 92
              }
            }
          }
        },
93 94
        "responses": {
          "201": {
Michel Roy's avatar
Michel Roy committed
95 96 97 98
            "description": "Upon success, the HTTP response shall include a 'Location' HTTP header that contains the resource URI of the created resource.",
            "content": {
              "application/json": {
                "schema": {
Michel Roy's avatar
Michel Roy committed
99
                  "$ref": "#/components/schemas/BwInfo"
Michel Roy's avatar
Michel Roy committed
100 101 102
                }
              }
            }
103 104
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
105
            "$ref": "#/components/responses/400"
106 107
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
108
            "$ref": "#/components/responses/403"
109 110
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
111
            "$ref": "#/components/responses/404"
112
          }
113
        }
114
      }
115
    },
116 117 118
    "/bw_allocations/{allocationId}": {
      "get": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
119
          "bwm"
Michel Roy's avatar
Michel Roy committed
120 121 122 123 124 125 126 127
        ],
        "summary": "Retrieve information about a specific bandwidthAllocation",
        "description": "Retrieves information about a bandwidthAllocation resource. Typically used in 'Get configured bandwidth allocation from Bandwidth Management Service' procedure as described in clause 6.2.5.",
        "operationId": "bandwidthAllocationGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.allocationId"
          }
128 129 130
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
131 132 133 134
            "description": "Used to indicate nonspecific success. The response body contains a representation of the resource.",
            "content": {
              "application/json": {
                "schema": {
Michel Roy's avatar
Michel Roy committed
135
                  "$ref": "#/components/schemas/BwInfo"
Michel Roy's avatar
Michel Roy committed
136 137 138
                }
              }
            }
139 140
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
141
            "$ref": "#/components/responses/400"
142 143
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
144
            "$ref": "#/components/responses/403"
145 146
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
147
            "$ref": "#/components/responses/404"
148
          }
149 150
        }
      },
151
      "put": {
Michel Roy's avatar
Michel Roy committed
152
        "tags": [
Michel Roy's avatar
Michel Roy committed
153
          "bwm"
Michel Roy's avatar
Michel Roy committed
154 155 156 157
        ],
        "summary": "Update the information about a specific bandwidthAllocation",
        "description": "Updates the information about a bandwidthAllocation resource. As specified in ETSI GS MEC 009 [6], the PUT HTTP method has 'replace' semantics.",
        "operationId": "bandwidthAllocationPUT",
158
        "requestBody": {
Michel Roy's avatar
Michel Roy committed
159 160 161 162 163
          "description": "BwInfo with updated information is included as entity body of the request.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
Michel Roy's avatar
Michel Roy committed
164
                "$ref": "#/components/schemas/BwInfo"
Michel Roy's avatar
Michel Roy committed
165 166 167
              }
            }
          }
168
        },
Michel Roy's avatar
Michel Roy committed
169 170 171 172
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.allocationId"
          }
173 174 175
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
176 177 178 179
            "description": "Used to indicate nonspecific success. The response body contains a representation of the resource.",
            "content": {
              "application/json": {
                "schema": {
Michel Roy's avatar
Michel Roy committed
180
                  "$ref": "#/components/schemas/BwInfo"
Michel Roy's avatar
Michel Roy committed
181 182 183
                }
              }
            }
184 185
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
186
            "$ref": "#/components/responses/400"
187 188
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
189
            "$ref": "#/components/responses/403"
190 191
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
192
            "$ref": "#/components/responses/404"
193 194
          },
          "412": {
Michel Roy's avatar
Michel Roy committed
195
            "$ref": "#/components/responses/412"
196 197 198 199
          }
        }
      },
      "patch": {
Michel Roy's avatar
Michel Roy committed
200
        "tags": [
Michel Roy's avatar
Michel Roy committed
201
          "bwm"
Michel Roy's avatar
Michel Roy committed
202 203 204 205
        ],
        "summary": "Modify the information about a specific existing bandwidthAllocation by sending updates on the data structure",
        "description": "Updates the information about a bandwidthAllocation resource. As specified in ETSI GS MEC 009 [6], the PATCH HTTP method updates a resource on top of the existing resource state by just including the changes ('deltas') in the request body.",
        "operationId": "bandwidthAllocationPATCH",
206
        "requestBody": {
Michel Roy's avatar
Michel Roy committed
207 208 209 210 211
          "description": "Description of the changes to instruct the server how to modify the resource representation.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
Michel Roy's avatar
Michel Roy committed
212
                "$ref": "#/components/schemas/BwInfoDeltas"
Michel Roy's avatar
Michel Roy committed
213 214 215
              }
            }
          }
216
        },
Michel Roy's avatar
Michel Roy committed
217 218 219 220
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.allocationId"
          }
221 222 223
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
224 225 226 227
            "description": "Used to indicate nonspecific success. The response body contains a representation of the resource.",
            "content": {
              "application/json": {
                "schema": {
Michel Roy's avatar
Michel Roy committed
228
                  "$ref": "#/components/schemas/BwInfo"
Michel Roy's avatar
Michel Roy committed
229 230 231
                }
              }
            }
232 233
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
234
            "$ref": "#/components/responses/400"
235 236
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
237
            "$ref": "#/components/responses/403"
238 239
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
240
            "$ref": "#/components/responses/404"
241 242
          },
          "412": {
Michel Roy's avatar
Michel Roy committed
243
            "$ref": "#/components/responses/412"
244
          }
245 246
        }
      },
247 248
      "delete": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
249
          "bwm"
Michel Roy's avatar
Michel Roy committed
250 251 252 253 254 255 256 257
        ],
        "summary": "Remove a specific bandwidthAllocation",
        "description": "Used in 'Unregister from Bandwidth Management Service' procedure as described in clause 6.2.3.",
        "operationId": "bandwidthAllocationDELETE",
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.allocationId"
          }
258 259 260
        ],
        "responses": {
          "204": {
Michel Roy's avatar
Michel Roy committed
261
            "$ref": "#/components/responses/204"
262 263
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
264
            "$ref": "#/components/responses/403"
265 266
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
267
            "$ref": "#/components/responses/404"
268 269 270 271 272 273
          }
        }
      }
    }
  },
  "components": {
Michel Roy's avatar
Michel Roy committed
274 275 276
    "responses": {
      "204": {
        "description": "Upon success, a response 204 No Content without any response body is returned."
277
      },
Michel Roy's avatar
Michel Roy committed
278 279
      "400": {
        "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
280
        "content": {
Michel Roy's avatar
Michel Roy committed
281
          "application/problem+json": {
282
            "schema": {
Michel Roy's avatar
Michel Roy committed
283
              "$ref": "#/components/schemas/ProblemDetails"
284 285 286 287
            }
          }
        }
      },
Michel Roy's avatar
Michel Roy committed
288 289
      "403": {
        "description": "Forbidden :  operation is not allowed given the current status of the resource.",
290
        "content": {
Michel Roy's avatar
Michel Roy committed
291
          "application/problem+json": {
292
            "schema": {
Michel Roy's avatar
Michel Roy committed
293
              "$ref": "#/components/schemas/ProblemDetails"
294 295 296 297
            }
          }
        }
      },
Michel Roy's avatar
Michel Roy committed
298 299
      "404": {
        "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
300
        "content": {
Michel Roy's avatar
Michel Roy committed
301
          "application/problem+json": {
302
            "schema": {
Michel Roy's avatar
Michel Roy committed
303
              "$ref": "#/components/schemas/ProblemDetails"
304
            }
305 306 307
          }
        }
      },
Michel Roy's avatar
Michel Roy committed
308 309
      "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",
310
        "content": {
Michel Roy's avatar
Michel Roy committed
311
          "application/problem+json": {
312
            "schema": {
Michel Roy's avatar
Michel Roy committed
313
              "$ref": "#/components/schemas/ProblemDetails"
314
            }
315
          }
316
        }
Michel Roy's avatar
Michel Roy committed
317 318 319 320 321 322 323 324 325 326
      }
    },
    "parameters": {
      "Path.allocationId": {
        "name": "allocationId",
        "in": "path",
        "description": "Represents a bandwidth allocation instance",
        "required": true,
        "schema": {
          "type": "string"
327 328
        }
      },
Michel Roy's avatar
Michel Roy committed
329 330 331 332 333 334 335 336 337
      "Query.app_instance_id": {
        "name": "app_instance_id",
        "in": "query",
        "description": "A MEC application instance may use multiple app_instance_ids as an input parameter to query the bandwidth allocation of a list of MEC application instances. See note.",
        "required": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
338 339 340
          }
        }
      },
Michel Roy's avatar
Michel Roy committed
341 342 343 344 345 346 347 348 349
      "Query.app_name": {
        "name": "app_name",
        "in": "query",
        "description": "A MEC application instance may use multiple app_names as an input parameter to query the bandwidth allocation of a list of MEC application instances. See note.",
        "required": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
350
          }
351 352
        }
      },
Michel Roy's avatar
Michel Roy committed
353 354 355 356 357 358 359 360 361
      "Query.session_id": {
        "name": "session_id",
        "in": "query",
        "description": "A MEC application instance may use session_id as an input parameter to query the bandwidth allocation of a list of sessions. See note.",
        "required": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
362 363 364 365 366
          }
        }
      }
    },
    "schemas": {
Michel Roy's avatar
Michel Roy committed
367
      "BwInfo": {
368
        "properties": {
Michel Roy's avatar
Michel Roy committed
369 370 371 372 373
          "allocationDirection": {
            "description": "The direction of the requested BW allocation: 00 = Downlink (towards the UE) 01 = Uplink (towards the application/session) 10 = Symmetrical",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
374
          },
Michel Roy's avatar
Michel Roy committed
375 376 377 378 379
          "appInsId": {
            "description": "Application instance identifier",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
380
          },
Michel Roy's avatar
Michel Roy committed
381 382 383 384 385
          "fixedAllocation": {
            "description": "Size of requested fixed BW allocation in [bps]",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
386
          },
Michel Roy's avatar
Michel Roy committed
387 388 389 390 391 392 393 394
          "fixedBWPriority": {
            "description": "Indicates the allocation priority when dealing with several applications or sessions in parallel. Values are not defined in the present document",
            "enum": [
              "SEE_DESCRIPTION"
            ],
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Enum"
395
          },
Michel Roy's avatar
Michel Roy committed
396 397
          "requestType": {
            "description": "Numeric value (0 - 255) corresponding to specific type of consumer as following: 0 = APPLICATION_SPECIFIC_BW_ALLOCATION 1 = SESSION_SPECIFIC_BW_ALLOCATION",
Michel Roy's avatar
Michel Roy committed
398
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
            "enum": [
              0,
              1
            ],
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Enum_inlined"
          },
          "sessionFilter": {
            "description": "Session filtering criteria, applicable when requestType is set as SESSION_SPECIFIC_BW_ALLOCATION. Any filtering criteria shall define a single session only. In case multiple sessions match sessionFilter the request shall be rejected",
            "items": {
              "type": "object",
              "properties": {
                "dstAddress": {
                  "description": "Destination address identity of session (including range)",
                  "type": "string",
                  "x-etsi-mec-cardinality": "0..1",
                  "x-etsi-mec-origin-type": "String"
                },
                "dstPort": {
                  "description": "Destination port identity of session",
                  "items": {
                    "type": "string"
                  },
                  "minItems": 0,
                  "type": "array",
                  "x-etsi-mec-cardinality": "0..N",
                  "x-etsi-mec-origin-type": "String"
                },
                "protocol": {
                  "description": "Protocol number",
                  "type": "string",
                  "x-etsi-mec-cardinality": "0..1",
                  "x-etsi-mec-origin-type": "String"
                },
                "sourceIp": {
                  "description": "Source address identity of session (including range)",
                  "type": "string",
                  "x-etsi-mec-cardinality": "0..1",
                  "x-etsi-mec-origin-type": "String"
                },
                "sourcePort": {
                  "description": "Source port identity of session",
                  "items": {
                    "type": "string"
                  },
                  "minItems": 0,
                  "type": "array",
                  "x-etsi-mec-cardinality": "0..N",
                  "x-etsi-mec-origin-type": "String"
                }
              }
            },
            "minItems": 0,
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "Structure (inlined)"
          },
          "timeStamp": {
            "description": "Time stamp to indicate when the corresponding information elements are sent",
            "properties": {
              "nanoSeconds": {
                "description": "The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
Michel Roy's avatar
Michel Roy committed
461 462
                "format": "uint32",
                "type": "integer",
Michel Roy's avatar
Michel Roy committed
463 464 465 466
                "x-etsi-mec-cardinality": "1",
                "x-etsi-mec-origin-type": "Uint32"
              },
              "seconds": {
Michel Roy's avatar
Michel Roy committed
467
                "format": "uint32",
Michel Roy's avatar
Michel Roy committed
468 469 470 471 472 473 474 475 476 477 478 479 480
                "type": "integer",
                "description": "The seconds part of the Time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC",
                "x-etsi-mec-cardinality": "1",
                "x-etsi-mec-origin-type": "Uint32"
              }
            },
            "required": [
              "seconds",
              "nanoSeconds"
            ],
            "type": "object",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Structure (inlined)"
481
          }
Michel Roy's avatar
Michel Roy committed
482
        },
483 484 485 486 487 488
        "required": [
          "appInsId",
          "requestType",
          "fixedAllocation",
          "allocationDirection"
        ],
Michel Roy's avatar
Michel Roy committed
489 490 491 492
        "type": "object",
        "x-etsi-ref": "7.2.2"
      },
      "BwInfoDeltas": {
493
        "properties": {
Michel Roy's avatar
Michel Roy committed
494 495 496 497 498
          "allocationDirection": {
            "description": "The direction of the requested BW allocation: 00 = Downlink (towards the UE) 01 = Uplink (towards the application/session) 10 = Symmetrical",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
499 500
          },
          "appInsId": {
Michel Roy's avatar
Michel Roy committed
501 502 503 504
            "description": "Application instance identifier",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
505 506
          },
          "fixedAllocation": {
Michel Roy's avatar
Michel Roy committed
507 508 509 510
            "description": "Size of requested fixed BW allocation in [bps]",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
511
          },
Michel Roy's avatar
Michel Roy committed
512 513 514 515 516 517 518 519
          "fixedBWPriority": {
            "description": "Indicates the allocation priority when dealing with several applications or sessions in parallel. Values are not defined in the present document",
            "enum": [
              "SEE DESCRIPTION"
            ],
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Enum_inlined"
520 521
          },
          "requestType": {
Michel Roy's avatar
Michel Roy committed
522 523 524 525 526 527 528 529
            "description": "Numeric value (0 - 255) corresponding to specific type of consumer as following: 0 = APPLICATION_SPECIFIC_BW_ALLOCATION 1 = SESSION_SPECIFIC_BW_ALLOCATION",
            "type": "string",
            "enum": [
              0,
              1
            ],
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Enum_inlined"
530 531
          },
          "sessionFilter": {
Michel Roy's avatar
Michel Roy committed
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
            "description": "Session filtering criteria, applicable when requestType is set as SESSION_SPECIFIC_BW_ALLOCATION. Any filtering criteria shall define a single session only. In case multiple sessions match sessionFilter the request shall be rejected",
            "items": {
              "type": "object",
              "properties": {
                "dstAddress": {
                  "description": "Destination address identity of session (including range)",
                  "type": "string",
                  "x-etsi-mec-cardinality": "0..1",
                  "x-etsi-mec-origin-type": "String"
                },
                "dstPort": {
                  "description": "Destination port identity of session",
                  "items": {
                    "type": "string"
                  },
                  "minItems": 0,
                  "type": "array",
                  "x-etsi-mec-cardinality": "0..N",
                  "x-etsi-mec-origin-type": "String"
                },
                "protocol": {
                  "description": "Protocol number",
                  "type": "string",
                  "x-etsi-mec-cardinality": "0..1",
                  "x-etsi-mec-origin-type": "String"
                },
                "sourceIp": {
                  "description": "Source address identity of session (including range)",
                  "type": "string",
                  "x-etsi-mec-cardinality": "0..1",
                  "x-etsi-mec-origin-type": "String"
                },
                "sourcePort": {
                  "description": "Source port identity of session ",
                  "items": {
                    "type": "string"
                  },
                  "minItems": 0,
                  "type": "array",
                  "x-etsi-mec-cardinality": "0..N",
                  "x-etsi-mec-origin-type": "String"
                }
              }
            },
            "minItems": 0,
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "Structure (inlined)"
580
          }
Michel Roy's avatar
Michel Roy committed
581
        },
582
        "required": [
Michel Roy's avatar
Michel Roy committed
583 584
          "appInsId",
          "requestType"
585
        ],
Michel Roy's avatar
Michel Roy committed
586 587 588 589
        "type": "object",
        "x-etsi-ref": "7.2.3"
      },
      "ProblemDetails": {
590
        "properties": {
Michel Roy's avatar
Michel Roy committed
591 592 593 594 595
          "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"
596
          },
Michel Roy's avatar
Michel Roy committed
597 598 599 600 601 602 603 604 605
          "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",
Michel Roy's avatar
Michel Roy committed
606
            "format": "uint32",
Michel Roy's avatar
Michel Roy committed
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
            "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"
623
          }
Michel Roy's avatar
Michel Roy committed
624 625
        },
        "type": "object"
626
      }
627
    }
628
  }
Michel Roy's avatar
Michel Roy committed
629
}