WlanInformationApi.json 144 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"
    },
Michel Roy's avatar
Michel Roy committed
9
    "version": "2.2.1",
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
    }
  ],
piscione's avatar
piscione committed
22
23
24
25
  "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"
  },
Michel Roy's avatar
Michel Roy committed
26
27
28
  "tags": [
    {
      "name": "wai"
Michel Roy's avatar
Michel Roy committed
29
30
31
32
33
34
    }
  ],
  "paths": {
    "/queries/ap/ap_information": {
      "get": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
35
          "wai"
Michel Roy's avatar
Michel Roy committed
36
        ],
piscione's avatar
piscione committed
37
        "summary": "Queries information about existing WLAN Access Points",
Michel Roy's avatar
Michel Roy committed
38
39
40
41
        "description": "Queries information about existing WLAN Access Points",
        "operationId": "apInfoGET",
        "parameters": [
          {
piscione's avatar
piscione committed
42
43
44
45
46
47
48
49
            "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
50
51
          },
          {
piscione's avatar
piscione committed
52
53
54
55
56
57
58
59
            "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
60
61
          },
          {
piscione's avatar
piscione committed
62
63
64
65
66
67
68
69
70
71
72
            "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
73
74
          },
          {
piscione's avatar
piscione committed
75
76
77
78
79
80
81
82
83
84
85
            "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
86
87
          },
          {
piscione's avatar
piscione committed
88
89
90
91
92
93
94
95
96
97
98
            "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
99
100
101
102
103
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to ap_info request",
piscione's avatar
piscione committed
104
            "headers": {},
Michel Roy's avatar
Michel Roy committed
105
106
107
            "content": {
              "application/json": {
                "schema": {
Michel Roy's avatar
Michel Roy committed
108
109
110
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ApInfo"
piscione's avatar
piscione committed
111
112
113
                  },
                  "description": "",
                  "contentMediaType": "application/json"
Michel Roy's avatar
Michel Roy committed
114
115
116
117
118
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
119
120
121
122
123
124
125
126
127
            "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
128
129
          },
          "401": {
piscione's avatar
piscione committed
130
131
132
133
134
135
136
137
138
            "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
139
140
          },
          "403": {
piscione's avatar
piscione committed
141
142
143
144
145
146
147
148
149
            "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
150
151
          },
          "404": {
piscione's avatar
piscione committed
152
153
154
155
156
157
158
159
160
            "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
161
162
          },
          "406": {
piscione's avatar
piscione committed
163
164
165
166
167
168
169
170
171
            "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
172
173
          },
          "429": {
piscione's avatar
piscione committed
174
175
176
177
178
179
180
181
182
            "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
183
          }
piscione's avatar
piscione committed
184
185
186
187
        },
        "deprecated": false
      },
      "parameters": []
Michel Roy's avatar
Michel Roy committed
188
189
190
191
    },
    "/queries/sta/sta_information": {
      "get": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
192
          "wai"
Michel Roy's avatar
Michel Roy committed
193
        ],
piscione's avatar
piscione committed
194
        "summary": "Queries information about existing WLAN stations",
Michel Roy's avatar
Michel Roy committed
195
196
197
198
        "description": "Queries information about existing WLAN stations",
        "operationId": "staInfoGET",
        "parameters": [
          {
piscione's avatar
piscione committed
199
200
201
202
203
204
205
206
            "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
207
208
          },
          {
piscione's avatar
piscione committed
209
210
211
212
213
214
215
216
            "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
217
218
          },
          {
piscione's avatar
piscione committed
219
220
221
222
223
224
225
226
227
228
229
            "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
230
231
          },
          {
piscione's avatar
piscione committed
232
233
234
235
236
237
238
239
240
241
242
            "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
243
244
          },
          {
piscione's avatar
piscione committed
245
246
247
248
249
250
251
252
253
254
255
            "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
256
257
258
259
260
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to sta_info request",
piscione's avatar
piscione committed
261
            "headers": {},
Michel Roy's avatar
Michel Roy committed
262
263
264
            "content": {
              "application/json": {
                "schema": {
Michel Roy's avatar
Michel Roy committed
265
266
267
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/StaInfo"
piscione's avatar
piscione committed
268
269
270
                  },
                  "description": "",
                  "contentMediaType": "application/json"
Michel Roy's avatar
Michel Roy committed
271
272
273
274
275
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
276
277
278
279
280
281
282
283
284
            "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
285
286
          },
          "401": {
piscione's avatar
piscione committed
287
288
289
290
291
292
293
294
295
            "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
296
297
          },
          "403": {
piscione's avatar
piscione committed
298
299
300
301
302
303
304
305
306
            "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
307
308
          },
          "404": {
piscione's avatar
piscione committed
309
310
311
312
313
314
315
316
317
            "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
318
319
          },
          "406": {
piscione's avatar
piscione committed
320
321
322
323
324
325
326
327
328
            "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
329
330
          },
          "429": {
piscione's avatar
piscione committed
331
332
333
334
335
336
337
338
339
            "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
340
          }
piscione's avatar
piscione committed
341
342
343
344
        },
        "deprecated": false
      },
      "parameters": []
Michel Roy's avatar
Michel Roy committed
345
    },
Michel Roy's avatar
Michel Roy committed
346
    "/subscriptions": {
Michel Roy's avatar
Michel Roy committed
347
348
      "get": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
349
          "wai"
Michel Roy's avatar
Michel Roy committed
350
        ],
piscione's avatar
piscione committed
351
        "summary": "Queries information on subscriptions for notifications",
Michel Roy's avatar
Michel Roy committed
352
353
354
355
        "description": "Queries information on subscriptions for notifications",
        "operationId": "subscriptionLinkList_subscriptionsGET",
        "parameters": [
          {
piscione's avatar
piscione committed
356
357
358
359
360
361
362
363
            "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
364
365
366
367
368
          }
        ],
        "responses": {
          "200": {
            "description": "Response body contains the list of links to requestors subscriptions.",
piscione's avatar
piscione committed
369
            "headers": {},
Michel Roy's avatar
Michel Roy committed
370
371
372
            "content": {
              "application/json": {
                "schema": {
Michel Roy's avatar
Michel Roy committed
373
                  "$ref": "#/components/schemas/SubscriptionLinkList"
Michel Roy's avatar
Michel Roy committed
374
                },
piscione's avatar
piscione committed
375
376
377
                "examples": {
                  "example-of-subscription-link-list": {
                    "value": {
Michel Roy's avatar
Michel Roy committed
378
379
                      "_links": {
                        "self": {
piscione's avatar
piscione committed
380
                          "href": "http://meAppServer.example.com/wai/v2/subscriptions"
Michel Roy's avatar
Michel Roy committed
381
382
                        }
                      },
piscione's avatar
piscione committed
383
384
385
386
387
388
                      "subscription": [
                        {
                          "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123",
                          "subscriptionType": "AssocStaSubscription"
                        }
                      ]
Michel Roy's avatar
Michel Roy committed
389
                    }
piscione's avatar
piscione committed
390
                  }
Michel Roy's avatar
Michel Roy committed
391
392
393
394
395
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
396
397
398
399
400
401
402
403
404
            "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
405
406
          },
          "401": {
piscione's avatar
piscione committed
407
408
409
410
411
412
413
414
415
            "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
416
417
          },
          "403": {
piscione's avatar
piscione committed
418
419
420
421
422
423
424
425
426
            "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
427
428
          },
          "404": {
piscione's avatar
piscione committed
429
430
431
432
433
434
435
436
437
            "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
438
439
          },
          "406": {
piscione's avatar
piscione committed
440
441
442
443
444
445
446
447
448
            "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
449
450
          },
          "429": {
piscione's avatar
piscione committed
451
452
453
454
455
456
457
458
459
            "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
460
          }
piscione's avatar
piscione committed
461
462
        },
        "deprecated": false
Michel Roy's avatar
Michel Roy committed
463
464
465
      },
      "post": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
466
          "wai"
Michel Roy's avatar
Michel Roy committed
467
        ],
piscione's avatar
piscione committed
468
        "summary": "Creates a new subscription to WLAN Access Information notifications",
Michel Roy's avatar
Michel Roy committed
469
470
        "description": "Creates a new subscription to WLAN Access Information notifications",
        "operationId": "subscriptionsPOST",
piscione's avatar
piscione committed
471
        "parameters": [],
Michel Roy's avatar
Michel Roy committed
472
473
474
475
476
        "requestBody": {
          "description": "Subscription to be created",
          "content": {
            "application/json": {
              "schema": {
piscione's avatar
piscione committed
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
506
507
508
                "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
509
              },
piscione's avatar
piscione committed
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
              "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
529
530
531
                }
              }
            }
piscione's avatar
piscione committed
532
533
          },
          "required": true
Michel Roy's avatar
Michel Roy committed
534
535
536
537
        },
        "responses": {
          "201": {
            "description": "Successful subscription response",
piscione's avatar
piscione committed
538
            "headers": {},
Michel Roy's avatar
Michel Roy committed
539
540
541
            "content": {
              "application/json": {
                "schema": {
piscione's avatar
piscione committed
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
575
576
577
                  "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
578
                },
piscione's avatar
piscione committed
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
                "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
602
603
604
605
606
607
608
                    }
                  }
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
609
610
611
612
613
614
615
616
617
            "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
618
619
          },
          "401": {
piscione's avatar
piscione committed
620
621
622
623
624
625
626
627
628
            "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
629
630
          },
          "403": {
piscione's avatar
piscione committed
631
632
633
634
635
636
637
638
639
            "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
640
641
          },
          "404": {
piscione's avatar
piscione committed
642
643
644
645
646
647
648
649
650
            "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
651
652
          },
          "406": {
piscione's avatar
piscione committed
653
654
655
656
657
658
659
660
661
            "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
662
663
          },
          "415": {
piscione's avatar
piscione committed
664
665
666
667
668
669
670
671
672
            "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
673
674
          },
          "422": {
piscione's avatar
piscione committed
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
            "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
695
696
          },
          "429": {
piscione's avatar
piscione committed
697
698
699
700
701
702
703
704
705
            "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
706
707
          }
        },
piscione's avatar
piscione committed
708
        "deprecated": false,
Michel Roy's avatar
Michel Roy committed
709
710
711
712
713
714
715
716
717
718
719
720
721
        "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
722
723
                        "$ref": "#/components/schemas/InlineNotification"
                      },
piscione's avatar
piscione committed
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
                      "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
753
754
755
756
757
758
759
                        }
                      }
                    }
                  }
                },
                "responses": {
                  "204": {
piscione's avatar
piscione committed
760
                    "description": "No content"
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
              "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
1017
1018
1019
1020
                  }
                }
              }
            }
piscione's avatar
piscione committed
1021
1022
          },
          "required": true
Michel Roy's avatar
Michel Roy committed
1023
1024
1025
1026
        },
        "responses": {
          "200": {
            "description": "Successful subscription modification",
piscione's avatar
piscione committed
1027
            "headers": {},
Michel Roy's avatar
Michel Roy committed
1028
1029
1030
            "content": {
              "application/json": {
                "schema": {
piscione's avatar
piscione committed
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/AssocStaSubscription"
                    },
                    {
                      "$ref": "#/components/schemas/StaDataRateSubscription"
                    },
                    {
                      "$ref": "#/components/schemas/MeasurementReportSubscription"
                    }
                  ],
                  "examples": [
                    {
                      "_links": {
                        "self": {
                          "href": "http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123"
                        }
                      },
                      "callbackReference": "http://my.callback.com/wai/some-id",
                      "apId": {
                        "bssid": "005C0A0A0A0A",
                        "ssid": [
                          "myNetworkSsid"
                        ],
                        "ipAddress": [
                          "10.10.100.1"
                        ]
                      }
                    }
                  ],
                  "contentMediaType": "application/json"
Michel Roy's avatar
Michel Roy committed
1062
                },
piscione's avatar
piscione committed
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
                "examples": {
                  "example-sub-type": {
                    "value": {
                      "subscriptionType": "AssocStaSubscription",
                      "_links": {
                        "self": {
                          "href": "http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123"
                        }
                      },
                      "callbackReference": "http://my.callback.com/wai/some-id",
                      "apId": {
                        "bssid": "005C0A0A0A0A",
                        "ssid": [
                          "myNetworkSsid"
                        ],
                        "ipAddress": [
                          "10.10.100.1"
                        ]
                      }
Michel Roy's avatar
Michel Roy committed
1082
1083
1084
1085
1086
1087
1088
                    }
                  }
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
1089
1090
1091
1092
1093
1094
1095
1096
1097
            "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
1098
1099
          },
          "401": {
piscione's avatar
piscione committed
1100
1101
1102
1103
1104
1105
1106
1107
1108
            "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
1109
1110
          },
          "403": {
piscione's avatar
piscione committed
1111
1112
1113
1114
1115
1116
1117
1118
1119
            "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
1120
1121
          },
          "404": {
piscione's avatar
piscione committed
1122
1123
1124
1125
1126
1127
1128
1129
1130
            "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
1131
1132
          },
          "406": {
piscione's avatar
piscione committed
1133
1134
1135
1136
1137
1138
1139
1140
1141
            "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
1142
1143
          },
          "412": {
piscione's avatar
piscione committed
1144
1145
1146
1147
1148
1149
1150
1151
1152
            "description": "Precondition failed :  used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
1153
1154
          },
          "422": {
piscione's avatar
piscione committed
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
            "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
1175
1176
          },
          "429": {
piscione's avatar
piscione committed
1177
1178
1179
1180
1181
1182
1183
1184
1185
            "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
1186
          }
piscione's avatar
piscione committed
1187
1188
        },
        "deprecated": false
Michel Roy's avatar
Michel Roy committed
1189
1190
1191
      },
      "delete": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
1192
          "wai"
Michel Roy's avatar
Michel Roy committed
1193
        ],
piscione's avatar
piscione committed
1194
        "summary": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
Michel Roy's avatar
Michel Roy committed
1195
1196
1197
1198
        "description": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
        "operationId": "subscriptionsDELETE",
        "parameters": [
          {
piscione's avatar
piscione committed
1199
1200
1201
1202
1203
1204
1205
1206
            "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
1207
1208
1209
1210
          }
        ],
        "responses": {
          "204": {
piscione's avatar
piscione committed
1211
1212
1213
            "description": "No Content",
            "headers": {},
            "content": {}
Michel Roy's avatar
Michel Roy committed
1214
1215
          },
          "401": {
piscione's avatar
piscione committed
1216
1217
1218
1219
1220
1221
1222
1223
1224
            "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
1225
1226
          },
          "403": {
piscione's avatar
piscione committed
1227
1228
1229
1230
1231
1232
1233
1234
1235
            "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
1236
1237
          },
          "404": {
piscione's avatar
piscione committed
1238
1239
1240
1241
1242
1243
1244
1245
1246
            "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
1247
1248
          },
          "429": {
piscione's avatar
piscione committed
1249
1250
1251
1252
1253
1254
1255
1256
1257
            "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
1258
          }
piscione's avatar
piscione committed
1259
1260
1261
1262
        },
        "deprecated": false
      },
      "parameters": []
Michel Roy's avatar
Michel Roy committed
1263
1264
1265
1266
1267
1268
    },
    "/measurements": {
      "get": {
        "tags": [
          "wai"
        ],
piscione's avatar
piscione committed
1269
        "summary": "Queries information on measurements configuration",
Michel Roy's avatar
Michel Roy committed
1270
1271
        "description": "Queries information on measurements configuration",
        "operationId": "measurementLinkList_measurementsGET",
piscione's avatar
piscione committed
1272
        "parameters": [],
Michel Roy's avatar
Michel Roy committed
1273
1274
1275
        "responses": {
          "200": {
            "description": "Response body contains the list of links to requestors measurement configurations.",
piscione's avatar
piscione committed
1276
            "headers": {},
Michel Roy's avatar
Michel Roy committed
1277
1278
1279
1280
1281
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MeasurementConfigLinkList"
                },
piscione's avatar
piscione committed
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
                "examples": {
                  "example-measurement": {
                    "value": {
                      "_links": {
                        "self": {
                          "href": "http://meAppServer.example.com/wai/v2/measurements"
                        }
                      },
                      "measurementConfig": [
                        {
                          "href": "http://meAppServer.example.com/wai/v2/measurements/meas123",
                          "measurementId": "myId1"
                        }
                      ]
Michel Roy's avatar
Michel Roy committed
1296
                    }
piscione's avatar
piscione committed
1297
                  }
Michel Roy's avatar
Michel Roy committed
1298
1299
1300
1301
1302
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
1303
1304
1305
1306
1307
1308
1309
1310
1311
            "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
1312
1313
          },
          "401": {
piscione's avatar
piscione committed
1314
1315
1316
1317
1318
1319
1320
1321
1322
            "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
1323
1324
          },
          "403": {
piscione's avatar
piscione committed
1325
1326
1327
1328
1329
1330
1331
1332
1333
            "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
1334
1335
          },
          "404": {
piscione's avatar
piscione committed
1336
1337
1338
1339
1340
1341
1342
1343
1344
            "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
1345
1346
          },
          "406": {
piscione's avatar
piscione committed
1347
1348
1349
1350
1351
1352
1353
1354
1355
            "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
1356
1357
          },
          "429": {
piscione's avatar
piscione committed
1358
1359
1360
1361
1362
1363
1364
1365
1366
            "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
1367
          }
piscione's avatar
piscione committed
1368
1369
        },
        "deprecated": false
Michel Roy's avatar
Michel Roy committed
1370
1371
1372
1373
1374
      },
      "post": {
        "tags": [
          "wai"
        ],
piscione's avatar
piscione committed
1375
        "summary": "Creates a new measurement configuration",
Michel Roy's avatar
Michel Roy committed
1376
1377
        "description": "Creates a new measurement configuration",
        "operationId": "measurementsPOST",
piscione's avatar
piscione committed
1378
        "parameters": [],
Michel Roy's avatar
Michel Roy committed
1379
1380
1381
1382
1383
1384
1385
        "requestBody": {
          "description": "Measurement configuration information",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MeasurementConfig"
              },
piscione's avatar
piscione committed
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
              "examples": {
                "example-body": {
                  "value": {
                    "staId": [
                      {
                        "macId": "005C01111111",
                        "ssid": [
                          "myNetworkSsid",
                          "myOtherNetworkSsid"
                        ]
                      }
                    ],
                    "measurementId": "myId1",
                    "measurementInfo": {}
                  }
                }
Michel Roy's avatar
Michel Roy committed
1402
1403
              }
            }
piscione's avatar
piscione committed
1404
1405
          },
          "required": true
Michel Roy's avatar
Michel Roy committed
1406
1407
1408
1409
        },
        "responses": {
          "201": {
            "description": "Successful measurement configuration response",
piscione's avatar
piscione committed
1410
            "headers": {},
Michel Roy's avatar
Michel Roy committed
1411
1412
1413
1414
1415
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MeasurementConfig"
                },
piscione's avatar
piscione committed
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
                "examples": {
                  "example-response": {
                    "value": {
                      "_links": {
                        "self": {
                          "href": "http://meAppServer.example.com/wai/v2/measurements/meas123"
                        }
                      },
                      "staId": [
                        {
                          "macId": "005C01111111",
                          "ssid": [
                            "myNetworkSsid",
                            "myOtherNetworkSsid"
                          ]
                        }
                      ],
                      "measurementId": "myId1",
                      "measurementInfo": {}
Michel Roy's avatar
Michel Roy committed
1435
                    }
piscione's avatar
piscione committed
1436
                  }
Michel Roy's avatar
Michel Roy committed
1437
1438
1439
1440
1441
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
1442
1443
1444
1445
1446
1447
1448
1449
1450
            "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
1451
1452
          },
          "401": {
piscione's avatar
piscione committed
1453
1454
1455
1456
1457
1458
1459
1460
1461
            "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
1462
1463
          },
          "403": {
piscione's avatar
piscione committed
1464
1465
1466
1467
1468
1469
1470
1471
1472
            "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
1473
1474
          },
          "404": {
piscione's avatar
piscione committed
1475
1476
1477
1478
1479
1480
1481
1482
1483
            "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
1484
1485
          },
          "406": {
piscione's avatar
piscione committed
1486
1487
1488
1489
1490
1491
1492
1493
1494
            "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
1495
1496
          },
          "415": {
piscione's avatar
piscione committed
1497
1498
1499
1500
1501
1502
1503
1504
1505
            "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
1506
1507
          },
          "422": {
piscione's avatar
piscione committed
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
            "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
1528
1529
          },
          "429": {
piscione's avatar
piscione committed
1530
1531
1532
1533
1534
1535
1536
1537
1538
            "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
1539
          }
piscione's avatar
piscione committed
1540
1541
1542
1543
        },
        "deprecated": false
      },
      "parameters": []
Michel Roy's avatar
Michel Roy committed
1544
1545
1546
1547
1548
1549
    },
    "/measurements/{measurementConfigId}": {
      "get": {
        "tags": [
          "wai"
        ],
piscione's avatar
piscione committed
1550
        "summary": "Queries information about an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)",
Michel Roy's avatar
Michel Roy committed
1551
1552
1553
1554
        "description": "Queries information about an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)",
        "operationId": "measurementsGET",
        "parameters": [
          {
piscione's avatar
piscione committed