Newer
Older
"contact": {
"url": "https://forge.etsi.org/rep/mec/gs028-wai-api"
},
"title": "ETSI GS MEC 028 - WLAN Access Information API",
"version": "2.1.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.1.1 WLAN Information API",
"url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.01.01_60/gs_mec028v020101p.pdf"
},
"servers": [
{
"url": "https://localhost/wai/v2"
}
],
"tags": [
{
"name": "wai"
}
],
"paths": {
"/queries/ap/ap_information": {
"get": {
"tags": [
],
"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": [
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
],
"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"
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
}
}
}
}
},
"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"
}
}
}
},
],
"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"
"_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"
}
]
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
}
}
}
},
"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"
}
}
},
"post": {
"tags": [
],
"summary": "Create a new subscription",
"description": "Creates a new subscription to WLAN Access Information notifications",
"operationId": "subscriptionsPOST",
"requestBody": {
"description": "Subscription to be created",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InlineSubscription"
},
"example": {
"subscriptionType": "AssocStaSubscription",
"callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1",
"expiryDeadline": {
"seconds": 1977836800,
"nanoSeconds": 0
"apId": {
"macId": "005C0A0A0A0A",
"ssid": "myNetworkSsid",
"ipAddress": "10.10.100.1"
}
}
}
}
},
"responses": {
"201": {
"description": "Successful subscription response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InlineSubscription"
"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": {
"macId": "005C0A0A0A0A",
"ssid": "myNetworkSsid",
"ipAddress": "10.10.100.1"
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
}
}
}
}
},
"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"
},
"415": {
"$ref": "#/components/responses/415"
},
"422": {
"$ref": "#/components/responses/422"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"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"
},
"example": {
"notificationType": "AssocStaNotification",
"timeStamp": {
"seconds": 1977836800,
"nanoseconds": 0
},
"apId": {
"macId": "005C0A0A0A0A",
"ssid": "myNetworkSsid",
"ipAddress": "10.10.100.1"
"staId": {
"macId": "005C01111111",
"ssid": [
"myNetworkSsid",
"myOtherNetworkSsid"
],
"aid": "1122",
"ipAddress": "10.10.1.255"
}
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
}
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}": {
"get": {
"tags": [
],
"summary": "Retrieve information on current specific subscription",
"description": "Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
"operationId": "subscriptionsGET",
"parameters": [
{
"$ref": "#/components/parameters/Path.subscrId"
}
],
"responses": {
"200": {
"description": "Subscription information regarding subscription notifications",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InlineSubscription"
"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": {
"macId": "005C0A0A0A0A",
"ssid": "myNetworkSsid",
"ipAddress": "10.10.100.1"
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
}
}
}
}
},
"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"
}
}
},
"put": {
"tags": [
],
"summary": "Modify an existing subscription",
"description": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
"operationId": "subscriptionsPUT",
"requestBody": {
"description": "Subscription to be modified",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InlineSubscription"
},
"example": {
"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": {
"macId": "005C0A0A0A0A",
"ssid": "myNetworkSsid",
"ipAddress": "10.10.100.1"
}
}
}
}
},
"parameters": [
{
"$ref": "#/components/parameters/Path.subscrId"
}
],
"responses": {
"200": {
"description": "Successful subscription modification",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InlineSubscription"
"_links": {
"self": {
"href": "http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123"
},
"callbackReference": "http://my.callback.com/wai/some-id",
"apId": {
"macId": "005C0A0A0A0A"
467
468
469
470
471
472
473
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
}
}
}
}
},
"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"
},
"412": {
"$ref": "#/components/responses/412"
},
"422": {
"$ref": "#/components/responses/422"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"delete": {
"tags": [
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
],
"summary": "Cancel an existing subscription",
"description": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
"operationId": "subscriptionsDELETE",
"parameters": [
{
"$ref": "#/components/parameters/Path.subscrId"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
}
},
"components": {
"responses": {
"200": {
"description": "OK"
},
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"$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.",
"content": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"412": {
"description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
"content": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"415": {
"description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.",
"content": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"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.",
"content": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"application/problem+json": {
"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"
}
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"$ref": "#/components/schemas/ProblemDetails"
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
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
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
}
}
}
}
},
"parameters": {
"Path.subscrId": {
"name": "subscriptionId",
"in": "path",
"description": "Subscription Id, specifically the \"self\" returned in the subscription request",
"required": true,
"schema": {
"type": "string",
"format": "uri"
}
},
"Query.Filter": {
"name": "filter",
"in": "query",
"description": "Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. .",
"required": false,
"schema": {
"type": "string"
}
},
"Query.AllFields": {
"name": "all_fields",
"in": "query",
"description": "Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details.",
"required": false,
"schema": {
"type": "string"
}
},
"Query.Fields": {
"name": "fields",
"in": "query",
"description": "Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"Query.ExcludeFields": {
"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.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"Query.ExcludeDefault": {
"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",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"Query.SubscriptionType": {
"name": "subscription_type",
"in": "query",
"description": "Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate.",
"required": false,
"schema": {
"type": "string"
}
}
},
"schemas": {
"ApAssociated": {
"properties": {
"assocId": {
"description": "Unique number which identifies a particular association between the station and Access Point.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "string"
},
"ipAddress": {
"description": "IPv4 or IPv6 address allocated for the Access Point.",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "string"
},
"macId": {
"description": "Unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "string"
},
"ssid": {
"description": "Service Set Identifier to identify logical networks.",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
}
},
"required": [
"macId"
],
"type": "object",
"x-etsi-ref": "6.5.12"
},
"ApIdentity": {
"properties": {
"ipAddress": {
"description": "IPv4 or IPv6 address allocated for the Access Point.",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
},
"macId": {
"description": "Unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"ssid": {
"description": "Service Set Identifier to identify logical networks including Basic Service Set and Extended Service Set.",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
}
},
"required": [
"macId"
],
"type": "object",
"x-etsi-ref": "6.5.3"
},
"ApInfo": {
"properties": {
"apId": {
},
"channel": {
"description": "Channel configured for the Access Point.",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"extBssLoad": {
}
},
"required": [
"apId"
],
"type": "object",
"x-etsi-ref": "6.2.2"
},
"ApLocation": {
"properties": {
"civicLocation": {
}
},
"type": "object",
"x-etsi-ref": "6.5.9"
},
"AssocStaNotification": {
"properties": {
"apId": {
},
"notificationType": {
"description": "Shall be set to \"AssocStaNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"staId": {
"description": "Identifier(s) to uniquely specify the client station(s) associated.",
"items": {
"$ref": "#/components/schemas/StaIdentity"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "StaIdentity"
},
"timeStamp": {
}
},
"required": [
"notificationType",
"apId"
],
"type": "object",
"x-etsi-ref": "6.4.2"
},
"AssocStaSubscription": {
"properties": {
"_links": {
"description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.",
"properties": {
"self": {
"type": "object",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"apId": {
},
"callbackReference": {
"description": "URI selected by the service consumer to receive notifications on the subscribed WLAN information. This shall be included both in the request and in response.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "URI"
},
"expiryDeadline": {
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
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
},
"subscriptionType": {
"description": "Shall be set to \"AssocStaSubscription\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
},
"required": [
"subscriptionType",
"callbackReference",
"apId"
],
"type": "object",
"x-etsi-ref": "6.3.2"
},
"AssociatedStations": {
"properties": {
"assocId": {
"description": "Unique number which identifies a particular association between an Access Point and a station.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "string"
},
"ipAddress": {
"description": "IPv4 or IPv6 address allocated for the station associated with the Access Point.",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "string"
},
"macId": {
"description": "Unique identifier assigned to a station (as network interface controller) for communications at the data link layer of a network segment.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "string"
}
},
"required": [
"macId"
],
"type": "object",
"x-etsi-ref": "6.5.5"
},
"BeaconReport": {
"properties": {
"bssId": {
"description": "The BSSID field indicates the BSSID of the BSS(s) for which a beacon report has been received.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "String"
},
"channelId": {
"description": "Channel number where the beacon was received.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Integer"
},
"measurementId": {
"description": "Measurement ID of the Measurement configuration applied to this Beacon Report.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"reportingCondition": {
"description": "As in table T9-89 of IEEE 802.11-2012 [8].",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Integer"
},
"ssId": {
"description": "(Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is received.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "String"
},
"staId": {