Newer
Older
"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"
},
"license": {
"name": "BSD-3-Clause",
"url": "https://forge.etsi.org/legal-matters"
}
},
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
"url": "https://localhost/wai/v2",
"variables": {}
"name": "wai",
"description": "WLAN Access Information"
}
],
"paths": {
"/queries/ap/ap_information": {
"get": {
"tags": [
"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",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApInfo"
},
"description": "",
"contentMediaType": "application/json"
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"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"
}
}
}
"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"
}
}
}
"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": [
"summary": "Queries information about existing WLAN stations",
"description": "Queries information about existing WLAN stations",
"operationId": "staInfoGET",
"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 sta_info request",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StaInfo"
},
"description": "",
"contentMediaType": "application/json"
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"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"
}
}
}
"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"
}
}
}
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"deprecated": false
},
"parameters": []
"summary": "Queries information on subscriptions for notifications",
"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: assoc_sta, sta_data_rate, measure_report.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Response body contains the list of links to requestors subscriptions.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionLinkList"
"examples": {
"example-of-subscription-link-list": {
"value": {
"href": "http://meAppServer.example.com/wai/v2/subscriptions"
"subscription": [
{
"href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123",
"subscriptionType": "AssocStaSubscription"
}
]
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"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"
}
}
}
"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"
}
}
}
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"summary": "Creates a new subscription to WLAN Access Information notifications",
"description": "Creates a new subscription to WLAN Access Information notifications",
"operationId": "subscriptionsPOST",
"requestBody": {
"description": "Subscription to be created",
"content": {
"application/json": {
"schema": {
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
"oneOf": [
{
"$ref": "#/components/schemas/AssocStaSubscription"
},
{
"$ref": "#/components/schemas/StaDataRateSubscription"
},
{
"$ref": "#/components/schemas/MeasurementReportSubscription"
}
],
"description": "Subscription to be created",
"examples": [
{
"subscriptionType": "AssocStaSubscription",
"callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1",
"expiryDeadline": {
"seconds": 1977836800,
"nanoSeconds": 0
},
"apId": {
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
}
}
],
"contentMediaType": "application/json"
"examples": {
"example-of-AssocStaSubscription": {
"value": {
"subscriptionType": "AssocStaSubscription",
"callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1",
"expiryDeadline": {
"seconds": 1977836800,
"nanoSeconds": 0
},
"apId": {
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
}
}
},
"responses": {
"201": {
"description": "Successful subscription response",
"content": {
"application/json": {
"schema": {
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
"oneOf": [
{
"$ref": "#/components/schemas/AssocStaSubscription"
},
{
"$ref": "#/components/schemas/StaDataRateSubscription"
},
{
"$ref": "#/components/schemas/MeasurementReportSubscription"
}
],
"examples": [
{
"subscriptionType": "AssocStaSubscription",
"callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1",
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123"
}
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoSeconds": 0
},
"apId": {
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
}
}
],
"contentMediaType": "application/json"
"examples": {
"example-of-assoc--sta-subscription": {
"value": {
"subscriptionType": "AssocStaSubscription",
"callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1",
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123"
}
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoSeconds": 0
},
"apId": {
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
}
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"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"
}
}
}
"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"
}
}
}
"description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"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"
},
"examples": {
"application/problem+json": {
"value": {
"type": "https://meAppServer.example.com/wai/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"
}
}
}
}
}
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"callbacks": {
"notification": {
"{$request.body#/callbackReference}": {
"post": {
"summary": "Callback POST used to send a notification",
"description": "Notification from WAIS, content based on subscription type",
"operationId": "notificationPOST",
"requestBody": {
"description": "Subscription notification",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InlineNotification"
},
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
"examples": {
"example-assoc-sta-notification": {
"value": {
"notificationType": "AssocStaNotification",
"timeStamp": {
"seconds": 1977836800,
"nanoSeconds": 0
},
"apId": {
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
},
"staId": {
"macId": "005C01111111",
"ssid": [
"myNetworkSsid",
"myOtherNetworkSsid"
],
"aid": "1122",
"ipAddress": [
"10.10.1.255"
]
}
}
}
}
}
}
},
"responses": {
"204": {
},
"400": {
"description": "Bad Request"
},
"/subscriptions/{subscriptionId}": {
"get": {
"tags": [
"summary": "Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
"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\" returned in the subscription request",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Subscription information regarding subscription notifications",
"content": {
"application/json": {
"schema": {
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
"oneOf": [
{
"$ref": "#/components/schemas/AssocStaSubscription"
},
{
"$ref": "#/components/schemas/StaDataRateSubscription"
},
{
"$ref": "#/components/schemas/MeasurementReportSubscription"
}
],
"examples": [
{
"subscriptionType": "AssocStaSubscription",
"callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1",
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123"
}
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoSeconds": 0
},
"apId": {
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
}
}
],
"contentMediaType": "application/json"
"examples": {
"example-of-assoc-sta-subscription": {
"value": {
"subscriptionType": "AssocStaSubscription",
"callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1",
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123"
}
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoSeconds": 0
},
"apId": {
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
}
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"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"
}
}
}
"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"
}
}
}
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"summary": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
"description": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
"operationId": "subscriptionsPUT",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "Subscription Id, specifically the \"self\" returned in the subscription request",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Subscription to be modified",
"content": {
"application/json": {
"schema": {
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
"oneOf": [
{
"$ref": "#/components/schemas/AssocStaSubscription"
},
{
"$ref": "#/components/schemas/StaDataRateSubscription"
},
{
"$ref": "#/components/schemas/MeasurementReportSubscription"
}
],
"description": "Subscription to be modified",
"examples": [
{
"subscriptionType": "AssocStaSubscription",
"callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1",
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123"
}
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoSeconds": 0
},
"apId": {
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
}
}
],
"contentMediaType": "application/json"