WlanInformationApi.json

{
  "openapi": "3.0.0",
  "info": {
    "contact": {
      "url": "https://forge.etsi.org/rep/mec/gs028-wai-api"
    },
    "title": "ETSI GS MEC 028 - WLAN Access Information API",
    "version": "2.2.1",
    "description": "The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI",
    "license": {
      "name": "BSD-3-Clause",
      "url": "https://forge.etsi.org/legal-matters"
    }
  },
  "externalDocs": {
    "description": "ETSI MEC028 V2.2.1 WLAN Information API",
    "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.02.01_60/gs_mec028v020201p.pdf"
  },
  "servers": [
    {
      "url": "https://localhost/wai/v2"
    }
  ],
  "tags": [
    {
      "name": "wai"
    }
  ],
  "paths": {
    "/queries/ap/ap_information": {
      "get": {
        "tags": [
          "wai"
        ],
        "summary": "Retrieve information on existing Access Points",
        "description": "Queries information about existing WLAN Access Points",
        "operationId": "apInfoGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Query.Filter"
          },
          {
            "$ref": "#/components/parameters/Query.AllFields"
          },
          {
            "$ref": "#/components/parameters/Query.Fields"
          },
          {
            "$ref": "#/components/parameters/Query.ExcludeFields"
          },
          {
            "$ref": "#/components/parameters/Query.ExcludeDefault"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to ap_info request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ApInfo"
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        }
      }
    },
    "/queries/sta/sta_information": {
      "get": {
        "tags": [
          "wai"
        ],
        "summary": "Retrieve information on existing Stations",
        "description": "Queries information about existing WLAN stations",
        "operationId": "staInfoGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Query.Filter"
          },
          {
            "$ref": "#/components/parameters/Query.AllFields"
          },
          {
            "$ref": "#/components/parameters/Query.Fields"
          },
          {
            "$ref": "#/components/parameters/Query.ExcludeFields"
          },
          {
            "$ref": "#/components/parameters/Query.ExcludeDefault"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to sta_info request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/StaInfo"
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        }
      }
    },
    "/subscriptions": {
      "get": {
        "tags": [
          "wai"
        ],
        "summary": "Retrieve information on subscriptions for notifications",
        "description": "Queries information on subscriptions for notifications",
        "operationId": "subscriptionLinkList_subscriptionsGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Query.SubscriptionType"
          }
        ],
        "responses": {
          "200": {
            "description": "Response body contains the list of links to requestors subscriptions.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionLinkList"
                },
                "example": {
                  "_links": {
                    "self": {
                      "href": "http://meAppServer.example.com/wai/v2/subscriptions"
                    }
                  },
                  "subscription": [
                    {
                      "_links": {
                        "self": {
                          "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123"
                        }
                      },
                      "callbackReference": "http://my.callback.com/wai/assocStaSubscription/some-id",
                      "subscriptionType": "AssocStaSubscription"
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },