WlanInformationApi.json 146 KB
Newer Older
Michel Roy's avatar
Michel Roy committed
1
{
piscione's avatar
piscione committed
2
  "openapi": "3.1.0",
Michel Roy's avatar
Michel Roy committed
3
  "info": {
piscione's avatar
piscione committed
4
5
    "title": "ETSI GS MEC 028 - WLAN Access Information API",
    "description": "The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI",
Michel Roy's avatar
Michel Roy committed
6
7
8
    "contact": {
      "url": "https://forge.etsi.org/rep/mec/gs028-wai-api"
    },
9
    "version": "2.2.6",
Michel Roy's avatar
Michel Roy committed
10
11
12
13
14
    "license": {
      "name": "BSD-3-Clause",
      "url": "https://forge.etsi.org/legal-matters"
    }
  },
piscione's avatar
piscione committed
15
  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
Michel Roy's avatar
Michel Roy committed
16
17
  "servers": [
    {
piscione's avatar
piscione committed
18
19
      "url": "https://localhost/wai/v2",
      "variables": {}
Michel Roy's avatar
Michel Roy committed
20
21
22
23
    }
  ],
  "tags": [
    {
piscione's avatar
piscione committed
24
25
      "name": "wai",
      "description": "WLAN Access Information"
Michel Roy's avatar
Michel Roy committed
26
27
28
29
30
31
    }
  ],
  "paths": {
    "/queries/ap/ap_information": {
      "get": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
32
          "wai"
Michel Roy's avatar
Michel Roy committed
33
        ],
piscione's avatar
piscione committed
34
        "summary": "Queries information about existing WLAN Access Points",
Michel Roy's avatar
Michel Roy committed
35
36
37
38
        "description": "Queries information about existing WLAN Access Points",
        "operationId": "apInfoGET",
        "parameters": [
          {
piscione's avatar
piscione committed
39
40
41
42
43
44
45
46
            "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"
            }
Michel Roy's avatar
Michel Roy committed
47
48
          },
          {
piscione's avatar
piscione committed
49
50
51
52
53
54
55
56
            "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"
            }
Michel Roy's avatar
Michel Roy committed
57
58
          },
          {
piscione's avatar
piscione committed
59
60
61
62
63
64
65
66
67
68
69
            "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"
              }
            }
Michel Roy's avatar
Michel Roy committed
70
71
          },
          {
piscione's avatar
piscione committed
72
73
74
75
76
77
78
79
80
81
82
            "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"
              }
            }
Michel Roy's avatar
Michel Roy committed
83
84
          },
          {
piscione's avatar
piscione committed
85
86
87
88
89
90
91
92
93
94
95
            "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"
              }
            }
Michel Roy's avatar
Michel Roy committed
96
97
98
99
100
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to ap_info request",
piscione's avatar
piscione committed
101
            "headers": {},
Michel Roy's avatar
Michel Roy committed
102
103
104
            "content": {
              "application/json": {
                "schema": {
Michel Roy's avatar
Michel Roy committed
105
106
107
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ApInfo"
piscione's avatar
piscione committed
108
109
110
                  },
                  "description": "",
                  "contentMediaType": "application/json"
Michel Roy's avatar
Michel Roy committed
111
112
113
114
115
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
116
117
118
119
120
121
122
123
124
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
125
126
          },
          "401": {
piscione's avatar
piscione committed
127
128
129
130
131
132
133
134
135
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
136
137
          },
          "403": {
piscione's avatar
piscione committed
138
139
140
141
142
143
144
145
146
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
147
148
          },
          "404": {
piscione's avatar
piscione committed
149
150
151
152
153
154
155
156
157
            "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"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
158
159
          },
          "406": {
piscione's avatar
piscione committed
160
161
162
163
164
165
166
167
168
            "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"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
169
170
          },
          "429": {
piscione's avatar
piscione committed
171
172
173
174
175
176
177
178
179
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
180
          }
piscione's avatar
piscione committed
181
182
183
184
        },
        "deprecated": false
      },
      "parameters": []
Michel Roy's avatar
Michel Roy committed
185
186
187
188
    },
    "/queries/sta/sta_information": {
      "get": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
189
          "wai"
Michel Roy's avatar
Michel Roy committed
190
        ],
piscione's avatar
piscione committed
191
        "summary": "Queries information about existing WLAN stations",
Michel Roy's avatar
Michel Roy committed
192
193
194
195
        "description": "Queries information about existing WLAN stations",
        "operationId": "staInfoGET",
        "parameters": [
          {
piscione's avatar
piscione committed
196
197
198
199
200
201
202
203
            "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"
            }
Michel Roy's avatar
Michel Roy committed
204
205
          },
          {
piscione's avatar
piscione committed
206
207
208
209
210
211
212
213
            "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"
            }
Michel Roy's avatar
Michel Roy committed
214
215
          },
          {
piscione's avatar
piscione committed
216
217
218
219
220
221
222
223
224
225
226
            "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"
              }
            }
Michel Roy's avatar
Michel Roy committed
227
228
          },
          {
piscione's avatar
piscione committed
229
230
231
232
233
234
235
236
237
238
239
            "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"
              }
            }
Michel Roy's avatar
Michel Roy committed
240
241
          },
          {
piscione's avatar
piscione committed
242
243
244
245
246
247
248
249
250
251
252
            "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"
              }
            }
Michel Roy's avatar
Michel Roy committed
253
254
255
256
257
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to sta_info request",
piscione's avatar
piscione committed
258
            "headers": {},
Michel Roy's avatar
Michel Roy committed
259
260
261
            "content": {
              "application/json": {
                "schema": {
Michel Roy's avatar
Michel Roy committed
262
263
264
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/StaInfo"
piscione's avatar
piscione committed
265
266
267
                  },
                  "description": "",
                  "contentMediaType": "application/json"
Michel Roy's avatar
Michel Roy committed
268
269
270
271
272
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
273
274
275
276
277
278
279
280
281
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
282
283
          },
          "401": {
piscione's avatar
piscione committed
284
285
286
287
288
289
290
291
292
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
293
294
          },
          "403": {
piscione's avatar
piscione committed
295
296
297
298
299
300
301
302
303
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
304
305
          },
          "404": {
piscione's avatar
piscione committed
306
307
308
309
310
311
312
313
314
            "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"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
315
316
          },
          "406": {
piscione's avatar
piscione committed
317
318
319
320
321
322
323
324
325
            "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"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
326
327
          },
          "429": {
piscione's avatar
piscione committed
328
329
330
331
332
333
334
335
336
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
337
          }
piscione's avatar
piscione committed
338
339
340
341
        },
        "deprecated": false
      },
      "parameters": []
Michel Roy's avatar
Michel Roy committed
342
    },
Michel Roy's avatar
Michel Roy committed
343
    "/subscriptions": {
Michel Roy's avatar
Michel Roy committed
344
345
      "get": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
346
          "wai"
Michel Roy's avatar
Michel Roy committed
347
        ],
piscione's avatar
piscione committed
348
        "summary": "Queries information on subscriptions for notifications",
Michel Roy's avatar
Michel Roy committed
349
350
351
352
        "description": "Queries information on subscriptions for notifications",
        "operationId": "subscriptionLinkList_subscriptionsGET",
        "parameters": [
          {
piscione's avatar
piscione committed
353
354
355
356
357
358
359
360
            "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"
            }
Michel Roy's avatar
Michel Roy committed
361
362
363
364
365
          }
        ],
        "responses": {
          "200": {
            "description": "Response body contains the list of links to requestors subscriptions.",
piscione's avatar
piscione committed
366
            "headers": {},
Michel Roy's avatar
Michel Roy committed
367
368
369
            "content": {
              "application/json": {
                "schema": {
Michel Roy's avatar
Michel Roy committed
370
                  "$ref": "#/components/schemas/SubscriptionLinkList"
Michel Roy's avatar
Michel Roy committed
371
                },
piscione's avatar
piscione committed
372
373
374
                "examples": {
                  "example-of-subscription-link-list": {
                    "value": {
Michel Roy's avatar
Michel Roy committed
375
376
                      "_links": {
                        "self": {
piscione's avatar
piscione committed
377
                          "href": "http://meAppServer.example.com/wai/v2/subscriptions"
Michel Roy's avatar
Michel Roy committed
378
379
                        }
                      },
piscione's avatar
piscione committed
380
381
382
383
384
385
                      "subscription": [
                        {
                          "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123",
                          "subscriptionType": "AssocStaSubscription"
                        }
                      ]
Michel Roy's avatar
Michel Roy committed
386
                    }
piscione's avatar
piscione committed
387
                  }
Michel Roy's avatar
Michel Roy committed
388
389
390
391
392
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
393
394
395
396
397
398
399
400
401
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
402
403
          },
          "401": {
piscione's avatar
piscione committed
404
405
406
407
408
409
410
411
412
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
413
414
          },
          "403": {
piscione's avatar
piscione committed
415
416
417
418
419
420
421
422
423
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
424
425
          },
          "404": {
piscione's avatar
piscione committed
426
427
428
429
430
431
432
433
434
            "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"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
435
436
          },
          "406": {
piscione's avatar
piscione committed
437
438
439
440
441
442
443
444
445
            "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"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
446
447
          },
          "429": {
piscione's avatar
piscione committed
448
449
450
451
452
453
454
455
456
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
457
          }
piscione's avatar
piscione committed
458
459
        },
        "deprecated": false
Michel Roy's avatar
Michel Roy committed
460
461
462
      },
      "post": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
463
          "wai"
Michel Roy's avatar
Michel Roy committed
464
        ],
piscione's avatar
piscione committed
465
        "summary": "Creates a new subscription to WLAN Access Information notifications",
Michel Roy's avatar
Michel Roy committed
466
467
        "description": "Creates a new subscription to WLAN Access Information notifications",
        "operationId": "subscriptionsPOST",
piscione's avatar
piscione committed
468
        "parameters": [],
Michel Roy's avatar
Michel Roy committed
469
470
471
472
473
        "requestBody": {
          "description": "Subscription to be created",
          "content": {
            "application/json": {
              "schema": {
piscione's avatar
piscione committed
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"
Michel Roy's avatar
Michel Roy committed
506
              },
piscione's avatar
piscione committed
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
              "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"
                      ]
                    }
                  }
Michel Roy's avatar
Michel Roy committed
526
527
528
                }
              }
            }
piscione's avatar
piscione committed
529
530
          },
          "required": true
Michel Roy's avatar
Michel Roy committed
531
532
533
534
        },
        "responses": {
          "201": {
            "description": "Successful subscription response",
piscione's avatar
piscione committed
535
            "headers": {},
Michel Roy's avatar
Michel Roy committed
536
537
538
            "content": {
              "application/json": {
                "schema": {
piscione's avatar
piscione committed
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"
Michel Roy's avatar
Michel Roy committed
575
                },
piscione's avatar
piscione committed
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
                "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"
                        ]
                      }
Michel Roy's avatar
Michel Roy committed
599
600
601
602
603
604
605
                    }
                  }
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
606
607
608
609
610
611
612
613
614
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
615
616
          },
          "401": {
piscione's avatar
piscione committed
617
618
619
620
621
622
623
624
625
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
626
627
          },
          "403": {
piscione's avatar
piscione committed
628
629
630
631
632
633
634
635
636
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
637
638
          },
          "404": {
piscione's avatar
piscione committed
639
640
641
642
643
644
645
646
647
            "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"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
648
649
          },
          "406": {
piscione's avatar
piscione committed
650
651
652
653
654
655
656
657
658
            "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"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
659
660
          },
          "415": {
piscione's avatar
piscione committed
661
662
663
664
665
666
667
668
669
            "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"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
670
671
          },
          "422": {
piscione's avatar
piscione committed
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
            "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"
                    }
                  }
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
692
693
          },
          "429": {
piscione's avatar
piscione committed
694
695
696
697
698
699
700
701
702
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
703
704
          }
        },
piscione's avatar
piscione committed
705
        "deprecated": false,
Michel Roy's avatar
Michel Roy committed
706
707
708
709
710
711
712
713
714
715
716
717
718
        "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": {
Michel Roy's avatar
Michel Roy committed
719
720
                        "$ref": "#/components/schemas/InlineNotification"
                      },
piscione's avatar
piscione committed
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"
                              ]
                            }
                          }
Michel Roy's avatar
Michel Roy committed
750
751
752
753
754
755
756
                        }
                      }
                    }
                  }
                },
                "responses": {
                  "204": {
piscione's avatar
piscione committed
757
                    "description": "No content"
piscione's avatar
piscione committed
758
759
760
                  },
                  "400": {
                    "description": "Bad Request"
Michel Roy's avatar
Michel Roy committed
761
762
763
764
765
766
                  }
                }
              }
            }
          }
        }
piscione's avatar
piscione committed
767
768
      },
      "parameters": []
Michel Roy's avatar
Michel Roy committed
769
770
771
772
    },
    "/subscriptions/{subscriptionId}": {
      "get": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
773
          "wai"
Michel Roy's avatar
Michel Roy committed
774
        ],
piscione's avatar
piscione committed
775
        "summary": "Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
Michel Roy's avatar
Michel Roy committed
776
777
778
779
        "description": "Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
        "operationId": "subscriptionsGET",
        "parameters": [
          {
piscione's avatar
piscione committed
780
781
782
783
784
785
786
787
            "name": "subscriptionId",
            "in": "path",
            "description": "Subscription Id, specifically the \"self\" returned in the subscription request",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
Michel Roy's avatar
Michel Roy committed
788
789
790
791
792
          }
        ],
        "responses": {
          "200": {
            "description": "Subscription information regarding subscription notifications",
piscione's avatar
piscione committed
793
            "headers": {},
Michel Roy's avatar
Michel Roy committed
794
795
796
            "content": {
              "application/json": {
                "schema": {
piscione's avatar
piscione committed
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"
Michel Roy's avatar
Michel Roy committed
833
                },
piscione's avatar
piscione committed
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
                "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"
                        ]
                      }
Michel Roy's avatar
Michel Roy committed
857
858
859
860
861
862
863
                    }
                  }
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
864
865
866
867
868
869
870
871
872
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
873
874
          },
          "401": {
piscione's avatar
piscione committed
875
876
877
878
879
880
881
882
883
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
884
885
          },
          "403": {
piscione's avatar
piscione committed
886
887
888
889
890
891
892
893
894
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
895
896
          },
          "404": {
piscione's avatar
piscione committed
897
898
899
900
901
902
903
904
905
            "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"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
906
907
          },
          "406": {
piscione's avatar
piscione committed
908
909
910
911
912
913
914
915
916
            "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"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
917
918
          },
          "429": {
piscione's avatar
piscione committed
919
920
921
922
923
924
925
926
927
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
928
          }
piscione's avatar
piscione committed
929
930
        },
        "deprecated": false
Michel Roy's avatar
Michel Roy committed
931
932
933
      },
      "put": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
934
          "wai"
Michel Roy's avatar
Michel Roy committed
935
        ],
piscione's avatar
piscione committed
936
        "summary": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
Michel Roy's avatar
Michel Roy committed
937
938
        "description": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
        "operationId": "subscriptionsPUT",
piscione's avatar
piscione committed
939
940
941
942
943
944
945
946
947
948
949
950
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "Subscription Id, specifically the \"self\" returned in the subscription request",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
Michel Roy's avatar
Michel Roy committed
951
952
953
954
955
        "requestBody": {
          "description": "Subscription to be modified",
          "content": {
            "application/json": {
              "schema": {
piscione's avatar
piscione committed
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"
Michel Roy's avatar
Michel Roy committed
993
              },
piscione's avatar
piscione committed
994
995
996
997
998
999
1000
              "examples": {
                "example-of-assoc-sta-subscription": {
                  "value": {
                    "subscriptionType": "AssocStaSubscription",
                    "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1",
                    "_links": {
                      "self": {
For faster browsing, not all history is shown. View entire blame