WlanInformationApi.json

{
  "openapi": "3.1.0",
  "info": {
    "title": "ETSI GS MEC 028 - WLAN Access Information API",
    "description": "The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI",
    "contact": {
      "url": "https://forge.etsi.org/rep/mec/gs028-wai-api"
    },
    "version": "2.2.1",
    "license": {
      "name": "BSD-3-Clause",
      "url": "https://forge.etsi.org/legal-matters"
    }
  },
  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
  "servers": [
    {
      "url": "https://localhost/wai/v2",
      "variables": {}
    }
  ],
  "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"
  },
  "tags": [
    {
      "name": "wai"
    }
  ],
  "paths": {
    "/queries/ap/ap_information": {
      "get": {
        "tags": [
          "wai"
        ],
        "summary": "Queries information about existing WLAN Access Points",
        "description": "Queries information about existing WLAN Access Points",
        "operationId": "apInfoGET",
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "description": "Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. .",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "all_fields",
            "in": "query",
            "description": "Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "exclude_fields",
            "in": "query",
            "description": "Complex attributes to be excluded from the response. See clause 6.18 of ETSI GS MEC 009 for details.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "exclude_default",
            "in": "query",
            "description": "Indicates to exclude the following complex attributes from the response. See clause 6.18 of ETSI GS MEC 009 for details. The following attributes shall be excluded from the structure in the response body if this parameter is provided, or none of the parameters \"all_fields\", \"fields\", \"exclude_fields\", \"exclude_default\" are provided: Not applicable",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to ap_info request",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ApInfo"
                  },
                  "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/sta/sta_information": {
      "get": {
        "tags": [
          "wai"
        ],
        "summary": "Queries information about existing WLAN stations",
        "description": "Queries information about existing WLAN stations",
        "operationId": "staInfoGET",
        "parameters": [
          {
            "name": "filter",
            "in": "query",