Skip to content
RniAPI.json 168 KiB
Newer Older
Michel Roy's avatar
Michel Roy committed
  "openapi": "3.0.0",
  "info": {
Michel Roy's avatar
Michel Roy committed
    "contact": {
      "url": "https://forge.etsi.org/rep/mec/gs012-rnis-api"
    },
Michel Roy's avatar
Michel Roy committed
    "title": "ETSI GS MEC 012 - Radio Network Information API",
    "version": "2.1.1",
    "description": "The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.",
    "license": {
admin_forge's avatar
admin_forge committed
      "name": "BSD-3-Clause",
      "url": "https://forge.etsi.org/legal-matters"
    }
  },
  "externalDocs": {
Michel Roy's avatar
Michel Roy committed
    "description": "ETSI GS MEC 012 Radio Network Information API, V2.1.1",
    "url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/02.01.01_60/gs_mec012v020101p.pdf"
Michel Roy's avatar
Michel Roy committed
  "servers": [
Michel Roy's avatar
Michel Roy committed
      "url": "https://localhost/rni/v2"
    }
  ],
  "tags": [
    {
      "name": "rni"
    }
  ],
  "paths": {
Michel Roy's avatar
Michel Roy committed
    "/queries/rab_info": {
      "get": {
Michel Roy's avatar
Michel Roy committed
        "tags": [
Michel Roy's avatar
Michel Roy committed
          "rni"
Michel Roy's avatar
Michel Roy committed
        "summary": "Retrieve information on Radio Access Bearers",
        "description": "Queries information about the Radio Access Bearers",
        "operationId": "rab_infoGET",
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.AppInsId"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.CellId"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.UeIpv4Address"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.UeIpv6Address"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.NatedIpAddress"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.GtpTeid"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.ErabId"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.Qci"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.ErabMbrDl"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.ErabMbrUl"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.ErabGbrDl"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.ErabGbrUl"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to rab_info request",
Michel Roy's avatar
Michel Roy committed
            "content": {
              "application/json": {
Michel Roy's avatar
Michel Roy committed
                "schema": {
Michel Roy's avatar
Michel Roy committed
                  "$ref": "#/components/schemas/RabInfo"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/responses/400"
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/responses/401"
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/responses/403"
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/responses/404"
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/responses/406"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/responses/429"
Michel Roy's avatar
Michel Roy committed
        "x-swagger-router-controller": "queries"
Michel Roy's avatar
Michel Roy committed
    "/queries/plmn_info": {
      "get": {
Michel Roy's avatar
Michel Roy committed
        "tags": [
Michel Roy's avatar
Michel Roy committed
          "rni"
Michel Roy's avatar
Michel Roy committed
        "summary": "Retrieve information on the underlying Mobile Network that the MEC application is associated to",
        "description": "Queries information about the Mobile Network",
        "operationId": "plmn_infoGET",
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.AppInsIdArr"
          }
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
            "description": "Successful response to plmn_info request",
            "content": {
              "application/json": {
Michel Roy's avatar
Michel Roy committed
                "schema": {
Michel Roy's avatar
Michel Roy committed
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/PlmnInfo"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/responses/400"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/responses/401"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/responses/403"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/responses/404"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/responses/406"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/responses/429"
Michel Roy's avatar
Michel Roy committed
        "x-swagger-router-controller": "queries"
Michel Roy's avatar
Michel Roy committed
    "/queries/s1_bearer_info": {
      "get": {
Michel Roy's avatar
Michel Roy committed
        "tags": [
Michel Roy's avatar
Michel Roy committed
          "rni"
Michel Roy's avatar
Michel Roy committed
        "summary": "Retrieve S1-U bearer information related to specific UE(s)",
        "description": "Queries information about the S1 bearer(s)",
        "operationId": "s1_bearer_infoGET",
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.TempUeId"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.UeIpv4Address"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.UeIpv6Address"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.NatedIpAddress"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.GtpTeid"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.CellId"
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/parameters/Query.ErabIdArr"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to s1_bearer_info request",
Michel Roy's avatar
Michel Roy committed
            "content": {
              "application/json": {
                "schema": {
Michel Roy's avatar
Michel Roy committed
                  "$ref": "#/components/schemas/S1BearerInfo"
Loading
Loading full blame…