Skip to content
RniAPI.yaml-OpenApi31Yaml.yaml 107 KiB
Newer Older
piscione's avatar
piscione committed
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 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 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 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 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 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
openapi: 3.1.0
info:
  title: ETSI GS MEC 012 - Radio Network Information API
  description: The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
  contact:
    url: https://forge.etsi.org/rep/mec/gs012-rnis-api
  version: '2.1.1'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
servers:
- url: https://localhost/rni/v2
  variables: {}
paths:
  /queries/rab_info:
    get:
      tags:
      - rni
      summary: rab_infoGET
      description: Queries information about the Radio Access Bearers
      operationId: rab_infoGET
      parameters:
      - name: app_ins_id
        in: query
        description: Application instance identifier
        style: form
        explode: true
        schema:
          type: string
      - name: cell_id
        in: query
        description: Comma separated list of E-UTRAN Cell Identities
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ue_ipv4_address
        in: query
        description: Comma separated list of IE IPv4 addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ue_ipv6_address
        in: query
        description: Comma separated list of IE IPv6 addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: nated_ip_address
        in: query
        description: Comma separated list of IE NATed IP addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: gtp_teid
        in: query
        description: Comma separated list of GTP TEID addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: erab_id
        in: query
        description: E-RAB identifier
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: qci
        in: query
        description: QoS Class Identifier as defined in ETSI TS 123 401
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: erab_mbr_dl
        in: query
        description: Maximum downlink E-RAB Bit Rate as defined in ETSI TS 123 401
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: erab_mbr_ul
        in: query
        description: Maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: erab_gbr_dl
        in: query
        description: Guaranteed downlink E-RAB Bit Rate as defined in ETSI TS 123 401
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: erab_gbr_ul
        in: query
        description: Guaranteed uplink E-RAB Bit Rate as defined in ETSI TS 123 401
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      responses:
        '200':
          description: Successful response to rab_info request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RabInfo'
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+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.'
          headers: {}
          content:
            application/problem+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.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
  /queries/plmn_info:
    get:
      tags:
      - rni
      summary: plmn_infoGET
      description: Queries information about the Mobile Network
      operationId: plmn_infoGET
      parameters:
      - name: app_ins_id
        in: query
        description: Comma separated list of Application instance identifiers
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Successful response to plmn_info request
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlmnInfo'
                description: ''
                contentMediaType: application/json
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+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.'
          headers: {}
          content:
            application/problem+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.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
  /queries/s1_bearer_info:
    get:
      tags:
      - rni
      summary: s1_bearer_infoGET
      description: Queries information about the S1 bearer(s)
      operationId: s1_bearer_infoGET
      parameters:
      - name: temp_ue_id
        in: query
        description: Comma separated list of temporary identifiers allocated for the specific UE as defined in   ETSI TS 136 413
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ue_ipv4_address
        in: query
        description: Comma separated list of IE IPv4 addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ue_ipv6_address
        in: query
        description: Comma separated list of IE IPv6 addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: nated_ip_address
        in: query
        description: Comma separated list of IE NATed IP addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: gtp_teid
        in: query
        description: Comma separated list of GTP TEID addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: cell_id
        in: query
        description: Comma separated list of E-UTRAN Cell Identities
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: erab_id
        in: query
        description: Comma separated list of E-RAB identifiers
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
            contentEncoding: int32
      responses:
        '200':
          description: Successful response to s1_bearer_info request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S1BearerInfo'
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+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.'
          headers: {}
          content:
            application/problem+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.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
  /queries/layer2_meas:
    get:
      tags:
      - rni
      summary: layer2_meas_infoGET
      description: Queries information about the layer 2 measurements.
      operationId: layer2_meas_infoGET
      parameters:
      - name: app_ins_id
        in: query
        description: Application instance identifier
        style: form
        explode: true
        schema:
          type: string
      - name: cell_id
        in: query
        description: Comma separated list of E-UTRAN Cell Identities
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ue_ipv4_address
        in: query
        description: Comma separated list of IE IPv4 addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ue_ipv6_address
        in: query
        description: Comma separated list of IE IPv6 addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: nated_ip_address
        in: query
        description: Comma separated list of IE NATed IP addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: gtp_teid
        in: query
        description: Comma separated list of GTP TEID addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: dl_gbr_prb_usage_cell
        in: query
        description: PRB usage for downlink GBR traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_gbr_prb_usage_cell
        in: query
        description: PRB usage for uplink GBR traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_nongbr_prb_usage_cell
        in: query
        description: PRB usage for downlink non-GBR traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_nongbr_prb_usage_cell
        in: query
        description: PRB usage for uplink non-GBR traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_total_prb_usage_cell
        in: query
        description: PRB usage for total downlink traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_total_prb_usage_cell
        in: query
        description: PRB usage for total uplink traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: received_dedicated_preambles_cell
        in: query
        description: Received dedicated preambles in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: received_randomly_selected_preambles_low_range_cell
        in: query
        description: Received randomly selected preambles in the low range in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: received_randomly_selected_preambles_high_range_cell
        in: query
        description: Received rendomly selected preambles in the high range in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: number_of_active_ue_dl_gbr_cell
        in: query
        description: Number of active UEs with downlink GBR traffic as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: number_of_active_ue_ul_gbr_cell
        in: query
        description: Number of active UEs with uplink GBR traffic as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: number_of_active_ue_dl_nongbr_cell
        in: query
        description: Number of active UEs with downlink non-GBR traffic as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: number_of_active_ue_ul_nongbr_cell
        in: query
        description: Number of active UEs with uplink non-GBR traffic as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_gbr_pdr_cell
        in: query
        description: Packet discard rate for downlink GBR traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_gbr_pdr_cell
        in: query
        description: Packet discard rate for uplink GBR traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_nongbr_pdr_cell
        in: query
        description: Packet discard rate for downlink non-GBR traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_nongbr_pdr_cell
        in: query
        description: Packet discard rate for uplink non-GBR traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_gbr_delay_ue
        in: query
        description: Packet delay of downlink GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_gbr_delay_ue
        in: query
        description: Packet delay of uplink GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_nongbr_delay_ue
        in: query
        description: Packet delay of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_nongbr_delay_ue
        in: query
        description: Packet delay of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_gbr_pdr_ue
        in: query
        description: Packet discard rate of downlink GBR traffic of a UE in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_gbr_pdr_ue
        in: query
        description: Packet discard rate of uplink GBR traffic of a UE in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_nongbr_pdr_ue
        in: query
        description: Packet discard rate of downlink non-GBR traffic of a UE in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_nongbr_pdr_ue
        in: query
        description: Packet discard rate of uplink non-GBR traffic of a UE in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_gbr_throughput_ue
        in: query
        description: Scheduled throughput of downlink GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_gbr_throughput_ue
        in: query
        description: Scheduled throughput of uplink GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_nongbr_throughput_ue
        in: query
        description: Scheduled throughput of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_nongbr_throughput_ue
        in: query
        description: Scheduled throughput of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_gbr_data_volume_ue
        in: query
        description: Data volume of downlink GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_gbr_data_volume_ue
        in: query
        description: Data volume of uplink GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_nongbr_data_volume_ue
        in: query
        description: Data volume of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_nongbr_data_volume_ue
        in: query
        description: Data volume of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      responses:
        '200':
          description: Successful response to layer2 measurements info request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/L2Meas'
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+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.'
          headers: {}
          content:
            application/problem+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.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '414':
          description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
  /subscriptions:
    get:
      tags:
      - rni
      summary: subscriptionLinkList_subscriptionsGET
      description: Queries information on subscriptions for notifications
      operationId: subscriptionLinkList_subscriptionsGET
      parameters:
      - name: subscription_type
        in: query
        description: 'Filter on a specific subscription type. Permitted values: cell_change, rab_est, rab_mod, rab_rel, meas_rep_ue, nr_meas_rep_ue, timing_advance_ue, ca_reconf, s1_bearer.'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Response body contains the list of links to requestors subscriptions.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionLinkList'
              example:
                _links:
                  self:
                    href: http://meAppServer.example.com/rni/v2/subscriptions
                subscription:
                - _links:
                    self:
                      href: http://meAppServer.example.com/rni/v2/subscriptions/sub123
                  callbackReference: http://my.callback.com/rni-cell-change/some-id
                  subscriptionType: CellChangeSubscription
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+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.'
          headers: {}
          content:
            application/problem+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.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    post:
      tags:
      - rni
      summary: subscriptionsPOST
      description: Creates a new subscription to Radio Network Information notifications
      operationId: subscriptionsPOST
      parameters: []
      requestBody:
        description: Subscription to be created
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/CellChangeSubscription'
              - $ref: '#/components/schemas/RabEstSubscription'
              - $ref: '#/components/schemas/RabModSubscription'
              - $ref: '#/components/schemas/RabRelSubscription'
              - $ref: '#/components/schemas/MeasRepUeSubscription'
              - $ref: '#/components/schemas/NrMeasRepUeSubscription'
              - $ref: '#/components/schemas/MeasTaSubscription'
              - $ref: '#/components/schemas/CaReconfSubscription'
              - $ref: '#/components/schemas/S1BearerSubscription'
              description: Subscription to be created
              contentMediaType: application/json
        required: true
      responses:
        '201':
          description: Successful subscription
          headers: {}
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/CellChangeSubscription'
                - $ref: '#/components/schemas/RabEstSubscription'
                - $ref: '#/components/schemas/RabModSubscription'
                - $ref: '#/components/schemas/RabRelSubscription'
                - $ref: '#/components/schemas/MeasRepUeSubscription'
                - $ref: '#/components/schemas/NrMeasRepUeSubscription'
                - $ref: '#/components/schemas/MeasTaSubscription'
                - $ref: '#/components/schemas/CaReconfSubscription'
                - $ref: '#/components/schemas/S1BearerSubscription'
                contentMediaType: application/json
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+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.'
          headers: {}
          content:
            application/problem+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.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '415':
          description: 'Precondition failed :  used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT'
          headers: {}
          content:
            application/problem+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.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                application/problem+json:
                  type: https://meAppServer.example.com/rni/v2/probs/too-many targets
                  title: Too many targets
                  status: '422'
                  detail: The target area for the request is considered too large
                  instance: /meAppClient.example.com/77777/msgs/abc
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
  /subscriptions/{subscriptionId}:
    get:
      tags:
      - rni
      summary: subscriptionsGET
      description: Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)
      operationId: subscriptionsGET
      parameters:
      - name: subscriptionId
        in: path
        description: Subscription Id, specifically the "Self-referring URI" returned in the subscription request
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Subscription information regarding subscription notifications
          headers: {}
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/CellChangeSubscription'
                - $ref: '#/components/schemas/RabEstSubscription'
                - $ref: '#/components/schemas/RabModSubscription'
                - $ref: '#/components/schemas/RabRelSubscription'
                - $ref: '#/components/schemas/MeasRepUeSubscription'
                - $ref: '#/components/schemas/NrMeasRepUeSubscription'
                - $ref: '#/components/schemas/MeasTaSubscription'
                - $ref: '#/components/schemas/CaReconfSubscription'
                - $ref: '#/components/schemas/S1BearerSubscription'
                contentMediaType: application/json
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+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.'
          headers: {}
          content:
            application/problem+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.'