WlanInformationApi.yaml 111 KB
Newer Older
openapi: 3.1.0
info:
  title: ETSI GS MEC 028 - WLAN Access Information API
  description: The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
  contact:
    url: https://forge.etsi.org/rep/mec/gs028-wai-api
  version: '2.2.1'
  license:
    name: BSD-3-Clause
    url: 'https://forge.etsi.org/legal-matters'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
servers:
- url: https://localhost/wai/v2
  variables: {}
externalDocs:
  description: ETSI MEC028 V2.2.1 WLAN Information API
  url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.02.01_60/gs_mec028v020201p.pdf

tags:
- name: wai

paths:
  /queries/ap/ap_information:
    get:
      tags:
      summary: 'Queries information about existing WLAN Access Points'
Michel Roy's avatar
Michel Roy committed
      description: Queries information about existing WLAN Access Points
      operationId: apInfoGET
      parameters:
      - name: filter
        in: query
        description: Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. .
        style: form
        explode: true
        schema:
          type: string
      - name: all_fields
        in: query
        description: Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details.
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: exclude_fields
        in: query
        description: Complex attributes to be excluded from the response. See clause 6.18 of ETSI GS MEC 009 for details.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: exclude_default
        in: query
        description: 'Indicates to exclude the following complex attributes from the response. See clause 6.18 of ETSI GS MEC 009 for details. The following attributes shall be excluded from the structure in the response body if this parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields", "exclude_default" are provided: Not applicable'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Successful response to ap_info request
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApInfo'
                description: ''
                contentMediaType: application/json
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
  /queries/sta/sta_information:
    get:
      tags:
      summary: 'Queries information about existing WLAN stations'
Michel Roy's avatar
Michel Roy committed
      description: Queries information about existing WLAN stations
      operationId: staInfoGET
      parameters:
      - name: filter
        in: query
        description: Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. .
        style: form
        explode: true
        schema:
          type: string
      - name: all_fields
        in: query
        description: Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details.
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: exclude_fields
        in: query
        description: Complex attributes to be excluded from the response. See clause 6.18 of ETSI GS MEC 009 for details.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: exclude_default
        in: query
        description: 'Indicates to exclude the following complex attributes from the response. See clause 6.18 of ETSI GS MEC 009 for details. The following attributes shall be excluded from the structure in the response body if this parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields", "exclude_default" are provided: Not applicable'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Successful response to sta_info request
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StaInfo'
                description: ''
                contentMediaType: application/json
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
  /subscriptions:
    get:
      tags:
      summary: 'Queries information on subscriptions for notifications'
Michel Roy's avatar
Michel Roy committed
      description: Queries information on subscriptions for notifications
      operationId: subscriptionLinkList_subscriptionsGET
      parameters:
      - name: subscription_type
        in: query
        description: 'Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate, measure_report.'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Response body contains the list of links to requestors subscriptions.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionLinkList'
              examples:
                example-of-subscription-link-list:
                  value:
                   _links:
                     self:
                       href: 'http://meAppServer.example.com/wai/v2/subscriptions'
                   subscription:
                    - href: http://meAppServer.example.com/wai/v2/subscriptions/sub123
                      subscriptionType: AssocStaSubscription
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    post:
      tags:
      summary: 'Creates a new subscription to WLAN Access Information notifications'
Michel Roy's avatar
Michel Roy committed
      description: Creates a new subscription to WLAN Access Information notifications
      operationId: subscriptionsPOST
      parameters: []
      requestBody:
        description: Subscription to be created
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/AssocStaSubscription'
              - $ref: '#/components/schemas/StaDataRateSubscription'
              - $ref: '#/components/schemas/MeasurementReportSubscription'
              description: Subscription to be created
              examples:
              - subscriptionType: AssocStaSubscription
                callbackReference: http://meAppClient.example.com/wai/v2/notifications/1
                expiryDeadline:
                  seconds: 1977836800
                  nanoSeconds: 0
                apId:
                  bssid: 005C0A0A0A0A
                  ssid:
                  - myNetworkSsid
                  ipAddress:
                  - 10.10.100.1
              contentMediaType: application/json
            examples:
              example-of-AssocStaSubscription:
                value:
                 subscriptionType: AssocStaSubscription
                 callbackReference: http://meAppClient.example.com/wai/v2/notifications/1
                 expiryDeadline:
                   seconds: 1977836800
                   nanoSeconds: 0
                 apId:
                   bssid: 005C0A0A0A0A
                   ssid:
                   - myNetworkSsid
                   ipAddress:
                   - 10.10.100.1
        required: true
      responses:
        '201':
          description: Successful subscription response
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/AssocStaSubscription'
                - $ref: '#/components/schemas/StaDataRateSubscription'
                - $ref: '#/components/schemas/MeasurementReportSubscription'
                examples:
                - subscriptionType: AssocStaSubscription
                  callbackReference: http://meAppClient.example.com/wai/v2/notifications/1
                  _links:
                    self:
                      href: http://meAppServer.example.com/wai/v2/subscriptions/sub123
                  expiryDeadline:
                    seconds: 1977836800
                    nanoSeconds: 0
                  apId:
                    bssid: 005C0A0A0A0A
                    ssid:
                    - myNetworkSsid
                    ipAddress:
                    - 10.10.100.1
                contentMediaType: application/json
              examples:
                example-of-assoc--sta-subscription:
                  value:
                   subscriptionType: AssocStaSubscription
                   callbackReference: http://meAppClient.example.com/wai/v2/notifications/1
                   _links:
                     self:
                       href: http://meAppServer.example.com/wai/v2/subscriptions/sub123
                   expiryDeadline:
                     seconds: 1977836800
                     nanoSeconds: 0
                   apId:
                     bssid: 005C0A0A0A0A
                     ssid:
                     - myNetworkSsid
                     ipAddress:
                     - 10.10.100.1
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '415':
          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'
        '422':
          description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
                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
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
      callbacks: 
        notification:
          '{$request.body#/callbackReference}':
            post:
              summary: Callback POST used to send a notification
              description: 'Notification from WAIS, content based on subscription type'
              operationId: notificationPOST
              requestBody:
                 description: Subscription notification
                 required: true
                 content:
                   application/json:
                     schema:
                       $ref: '#/components/schemas/InlineNotification'
                     examples:
                       example-assoc-sta-notification:
                         value:
                           notificationType: AssocStaNotification
                           timeStamp:
                             seconds: 1977836800
                             nanoSeconds: 0
                           apId:
                             bssid: 005C0A0A0A0A
                             ssid:
                               - myNetworkSsid
                             ipAddress:
                               - 10.10.100.1
                           staId:
                             macId: 005C01111111
                             ssid:
                               - myNetworkSsid
                               - myOtherNetworkSsid
                             aid: '1122'
                             ipAddress:
                               - 10.10.1.255
              responses:
                '204':
                 description: "No content"


    parameters: []
  /subscriptions/{subscriptionId}:
    get:
      tags:
      summary: 'Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
      description: Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)
      operationId: subscriptionsGET
      parameters:
      - name: subscriptionId
        in: path
        description: Subscription Id, specifically the "self" returned in the subscription request
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Subscription information regarding subscription notifications
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/AssocStaSubscription'
                - $ref: '#/components/schemas/StaDataRateSubscription'
                - $ref: '#/components/schemas/MeasurementReportSubscription'
                examples:
                - subscriptionType: AssocStaSubscription
                  callbackReference: http://meAppClient.example.com/wai/v2/notifications/1
                  _links:
                    self:
                      href: http://meAppServer.example.com/wai/v2/subscriptions/sub123
                  expiryDeadline:
                    seconds: 1977836800
                    nanoSeconds: 0
                  apId:
                    bssid: 005C0A0A0A0A
                    ssid:
                    - myNetworkSsid
                    ipAddress:
                    - 10.10.100.1
                contentMediaType: application/json
              examples:
                example-of-assoc-sta-subscription:
                 value:
                   subscriptionType: AssocStaSubscription
                   callbackReference: http://meAppClient.example.com/wai/v2/notifications/1
                   _links:
                     self:
                       href: http://meAppServer.example.com/wai/v2/subscriptions/sub123
                   expiryDeadline:
                     seconds: 1977836800
                     nanoSeconds: 0
                   apId:
                     bssid: 005C0A0A0A0A
                     ssid:
                     - myNetworkSsid
                     ipAddress:
                     - 10.10.100.1
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    put:
      tags:
      summary: 'Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
      description: Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)
      operationId: subscriptionsPUT
      parameters:
      - name: subscriptionId
        in: path
        description: Subscription Id, specifically the "self" returned in the subscription request
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Subscription to be modified
        content:
          application/json:
            schema:
              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
            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
        required: true
      responses:
        '200':
          description: Successful subscription modification
          content:
            application/json:
              schema:
                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
              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
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '412':
          description: 'Precondition failed :  used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
                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
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    delete:
      tags:
      summary: 'Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
      description: Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)
      operationId: subscriptionsDELETE
      parameters:
      - name: subscriptionId
        in: path
        description: Subscription Id, specifically the "self" returned in the subscription request
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
Michel Roy's avatar
Michel Roy committed
  /measurements:
    get:
      tags:
      summary: 'Queries information on measurements configuration'
Michel Roy's avatar
Michel Roy committed
      description: Queries information on measurements configuration
      operationId: measurementLinkList_measurementsGET
      parameters: []
Michel Roy's avatar
Michel Roy committed
      responses:
        '200':
          description: Response body contains the list of links to requestors measurement configurations.
          headers: {}
Michel Roy's avatar
Michel Roy committed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeasurementConfigLinkList'
              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
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
        '401':
          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
        '403':
          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
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
Michel Roy's avatar
Michel Roy committed
    post:
      tags:
      summary: 'Creates a new measurement configuration'
Michel Roy's avatar
Michel Roy committed
      description: Creates a new measurement configuration
      operationId: measurementsPOST
      parameters: []
Michel Roy's avatar
Michel Roy committed
      requestBody:
        description: Measurement configuration information
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MeasurementConfig'
            examples:
              example-body:
                value:
                 staId:
                 - macId: 005C01111111
                   ssid:
                     - myNetworkSsid
                     - myOtherNetworkSsid
                 measurementId: myId1
                 measurementInfo: {}
        required: true
Michel Roy's avatar
Michel Roy committed
      responses:
        '201':
          description: Successful measurement configuration response
Michel Roy's avatar
Michel Roy committed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeasurementConfig'
              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
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
        '401':
          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
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
        '415':
          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
        '422':
          description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
                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
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
  /measurements/{measurementConfigId}:
Michel Roy's avatar
Michel Roy committed
    get:
      tags:
      summary: 'Queries information about an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)'
      description: 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
      operationId: measurementsGET