Skip to content
RniAPI.yaml-OpenApi31Yaml.yaml 107 KiB
Newer Older
piscione's avatar
piscione committed
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'
Loading full blame...