Commit 47f34e09 authored by Elian Kraja's avatar Elian Kraja
Browse files

Merge branch 'stf606-draft' into 'stf606-final' 

STF606 - Milestone A - Merge stf606-draft to stf606-final branch

See merge request !5
parents c3f09686 06b613fc

LocationAPI.json

+771 −696

File changed.

Preview size limit exceeded, changes collapsed.

LocationAPI.yaml

+524 −531
Original line number Diff line number Diff line 
openapi: 3.0.0

openapi: 3.1.0

info:

  contact:

    url: https://forge.etsi.org/rep/mec/gs013-location-api
@@ -232,8 +232,8 @@ paths: 
                properties:

                  notificationSubscriptionList:

                    $ref: '#/components/schemas/NotificationSubscriptionList'

                example:

                  notificationSubscriptionList:

                examples:

                  - notificationSubscriptionList:

                      circleNotificationSubscription:

                      - clientCorrelator: '0123'

                        callbackReference:
@@ -265,8 +265,8 @@ paths: 
              properties:

                circleNotificationSubscription:

                  $ref: '#/components/schemas/CircleNotificationSubscription'

              example:

                circleNotificationSubscription:

              examples:

                - circleNotificationSubscription:

                    clientCorrelator: '0123'

                    callbackReference:

                      callbackData: '1234'
@@ -289,8 +289,8 @@ paths: 
                properties:

                  circleNotificationSubscription:

                    $ref: '#/components/schemas/CircleNotificationSubscription'

                example:

                  circleNotificationSubscription:

                examples:

                  - circleNotificationSubscription:

                      clientCorrelator: '0123'

                      callbackReference:

                        callbackData: '1234'
@@ -333,8 +333,8 @@ paths: 
                      properties:

                        subscriptionNotification:

                          $ref: '#/components/schemas/SubscriptionNotification'

                      example:

                        subscriptionNotification:

                      examples:

                        - subscriptionNotification:

                            enteringLeavingCriteria: 'Entering'

                            isFinalNotification: false,

                            link:
@@ -376,8 +376,8 @@ paths: 
                properties:

                  circleNotificationSubscription:

                    $ref: '#/components/schemas/CircleNotificationSubscription'

                example:

                  circleNotificationSubscription:

                examples:

                  - circleNotificationSubscription:

                      clientCorrelator: '0123'

                      callbackReference:

                        callbackData: '1234'
@@ -420,8 +420,8 @@ paths: 
              properties:

                circleNotificationSubscription:

                  $ref: '#/components/schemas/CircleNotificationSubscription'

              example:

                circleNotificationSubscription:

              examples:

                - circleNotificationSubscription:

                    clientCorrelator: '0123'

                    callbackReference:

                      callbackData: '1234'
@@ -447,8 +447,8 @@ paths: 
                properties:

                  circleNotificationSubscription:

                    $ref: '#/components/schemas/CircleNotificationSubscription'

                example:

                  circleNotificationSubscription:

                examples:

                  - circleNotificationSubscription:

                      clientCorrelator: '0123'

                      callbackReference:

                        callbackData: '1234'
@@ -518,8 +518,8 @@ paths: 
                properties:

                  notificationSubscriptionList:

                    $ref: '#/components/schemas/NotificationSubscriptionList'

                example:

                  notificationSubscriptionList:

                examples:

                  - notificationSubscriptionList:

                      distanceNotificationSubscription:

                      - clientCorrelator: '0123'

                        callbackReference:
@@ -552,8 +552,8 @@ paths: 
              properties:

                distanceNotificationSubscription:

                  $ref: '#/components/schemas/DistanceNotificationSubscription'

              example:

                distanceNotificationSubscription:

              examples:

                - distanceNotificationSubscription:

                    clientCorrelator: '0123'

                    callbackReference:

                      callbackData: '1234'
@@ -577,8 +577,8 @@ paths: 
                properties:

                  distanceNotificationSubscription:

                    $ref: '#/components/schemas/DistanceNotificationSubscription'

                example:

                  distanceNotificationSubscription:

                examples:

                  - distanceNotificationSubscription:

                      clientCorrelator: '0123'

                      callbackReference:

                        callbackData: '1234'
@@ -622,8 +622,8 @@ paths: 
                      properties:

                        subscriptionNotification:

                          $ref: '#/components/schemas/SubscriptionNotification'

                      example:

                        subscriptionNotification:

                      examples:

                        - subscriptionNotification:

                            distanceCriteria: 'AllWithinDistance'

                            isFinalNotification: false,

                            link:
@@ -675,8 +675,8 @@ paths: 
                properties:

                  distanceNotificationSubscription:

                    $ref: '#/components/schemas/DistanceNotificationSubscription'

                example:

                  distanceNotificationSubscription:

                examples:

                  - distanceNotificationSubscription:

                      clientCorrelator: '0123'

                      callbackReference:

                        callbackData: '1234'
@@ -720,8 +720,8 @@ paths: 
              properties:

                distanceNotificationSubscription:

                  $ref: '#/components/schemas/DistanceNotificationSubscription'

              example:

                distanceNotificationSubscription:

              examples:

                - distanceNotificationSubscription:

                    clientCorrelator: '0123'

                    callbackReference:

                      callbackData: '1234'
@@ -748,8 +748,8 @@ paths: 
                properties:

                  distanceNotificationSubscription:

                    $ref: '#/components/schemas/DistanceNotificationSubscription'

                example:

                  distanceNotificationSubscription:

                examples:

                  - distanceNotificationSubscription:

                      clientCorrelator: '0123'

                      callbackReference:

                        callbackData: '1234'
@@ -820,8 +820,8 @@ paths: 
                properties:

                  notificationSubscriptionList:

                    $ref: '#/components/schemas/NotificationSubscriptionList'

                example:

                  notificationSubscriptionList:

                examples:

                  - notificationSubscriptionList:

                      periodicNotificationSubscription:

                      - clientCorrelator: '0123'

                        callbackReference:
@@ -848,8 +848,8 @@ paths: 
              properties:

                periodicNotificationSubscription:

                  $ref: '#/components/schemas/PeriodicNotificationSubscription'

              example:

                periodicNotificationSubscription:

              examples:

                - periodicNotificationSubscription:

                    clientCorrelator: '0123'

                    callbackReference:

                      callbackData: '1234'
@@ -867,8 +867,8 @@ paths: 
                properties:

                  periodicNotificationSubscription:

                    $ref: '#/components/schemas/PeriodicNotificationSubscription'

                example:

                  periodicNotificationSubscription:

                examples:

                  - periodicNotificationSubscription:

                      clientCorrelator: '0123'

                      callbackReference:

                        callbackData: '1234'
@@ -906,8 +906,8 @@ paths: 
                      properties:

                        subscriptionNotification:

                          $ref: '#/components/schemas/SubscriptionNotification'

                      example:

                        subscriptionNotification:

                      examples:

                        - subscriptionNotification:

                            isFinalNotification: false,

                            link:

                              rel: PeriodicNotificationSubscription
@@ -948,8 +948,8 @@ paths: 
                properties:

                  periodicNotificationSubscription:

                    $ref: '#/components/schemas/PeriodicNotificationSubscription'

                example:

                  periodicNotificationSubscription:

                examples:

                  - periodicNotificationSubscription:

                      clientCorrelator: '0123'

                      callbackReference:

                        callbackData: '1234'
@@ -987,8 +987,8 @@ paths: 
              properties:

                periodicNotificationSubscription:

                  $ref: '#/components/schemas/PeriodicNotificationSubscription'

              example:

                periodicNotificationSubscription:

              examples:

                - periodicNotificationSubscription:

                    clientCorrelator: '0123'

                    callbackReference:

                      callbackData: '1234'
@@ -1009,8 +1009,8 @@ paths: 
                properties:

                  periodicNotificationSubscription:

                    $ref: '#/components/schemas/PeriodicNotificationSubscription'

                example:

                  periodicNotificationSubscription:

                examples:

                  - periodicNotificationSubscription:

                      clientCorrelator: '0123'

                      callbackReference:

                        callbackData: '1234'
@@ -1075,8 +1075,8 @@ paths: 
                properties:

                  notificationSubscriptionList:

                    $ref: '#/components/schemas/NotificationSubscriptionList'

                example:

                  notificationSubscriptionList:

                examples:

                  - notificationSubscriptionList:

                      userTrackingSubscription:

                        - clientCorrelator: '0123'

                          resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/subscription123'
@@ -1107,8 +1107,8 @@ paths: 
              properties:

                userTrackingSubscription:

                  $ref: '#/components/schemas/UserTrackingSubscription'

              example:

                userTrackingSubscription:

              examples:

                - userTrackingSubscription:

                    clientCorrelator: '0123'

                    callbackReference:

                      notifyURL: 'http://my.callback.com/location_notifications/some-id'
@@ -1124,8 +1124,8 @@ paths: 
                properties:

                  userTrackingSubscription:

                    $ref: '#/components/schemas/UserTrackingSubscription'

                example:

                  userTrackingSubscription:

                examples:

                  - userTrackingSubscription:

                      clientCorrelator: '0123'

                      callbackReference:

                        notifyURL: 'http://my.callback.com/location_notifications/some-id'
@@ -1161,8 +1161,8 @@ paths: 
                      properties:

                        zonalPresenceNotification:

                          $ref: '#/components/schemas/ZonalPresenceNotification'

                      example:

                        zonalPresenceNotification:

                      examples:

                        - zonalPresenceNotification:

                            clientCorrelator: '0123'

                            zoneId: 'zone01'

                            address: 'acr:10.0.0.1'
@@ -1200,8 +1200,8 @@ paths: 
                properties:

                  userTrackingSubscription:

                    $ref: '#/components/schemas/UserTrackingSubscription'

                example:

                  userTrackingSubscription:

                examples:

                  - userTrackingSubscription:

                      clientCorrelator: '0123'

                      callbackReference:

                        notifyURL: 'http://my.callback.com/location_notifications/some-id'
@@ -1237,8 +1237,8 @@ paths: 
              properties:

                userTrackingSubscription:

                  $ref: '#/components/schemas/UserTrackingSubscription'

              example:

                userTrackingSubscription:

              examples:

                - userTrackingSubscription:

                    clientCorrelator: '0123'

                    callbackReference:

                      notifyURL: 'http://my.callback.com/location_notifications/some-id'
@@ -1257,8 +1257,8 @@ paths: 
                properties:

                  userTrackingSubscription:

                    $ref: '#/components/schemas/UserTrackingSubscription'

              example:

                userTrackingSubscription:

                examples:

                  - userTrackingSubscription:

                      clientCorrelator: '0123'

                      callbackReference:

                        notifyURL: 'http://my.callback.com/location_notifications/some-id'
@@ -1321,8 +1321,8 @@ paths: 
                properties:

                  notificationSubscriptionList:

                    $ref: '#/components/schemas/NotificationSubscriptionList'

                example:

                  notificationSubscriptionList:

                examples:

                  - notificationSubscriptionList:

                      zonalTrafficSubscription:

                        - clientCorrelator: '0123'

                          resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/subscription123'
@@ -1353,8 +1353,8 @@ paths: 
              properties:

                zonalTrafficSubscription:

                  $ref: '#/components/schemas/ZonalTrafficSubscription'

              example:

                zonalTrafficSubscription:

              examples:

                - zonalTrafficSubscription:

                    clientCorrelator: '0123'

                    callbackReference:

                      notifyURL: 'http://my.callback.com/location_notifications/some-id'
@@ -1370,8 +1370,8 @@ paths: 
                properties:

                  zonalTrafficSubscription:

                    $ref: '#/components/schemas/ZonalTrafficSubscription'

                example:

                  zonalTrafficSubscription:

                examples:

                  - zonalTrafficSubscription:

                      clientCorrelator: '0123'

                      callbackReference:

                        notifyURL: 'http://my.callback.com/location_notifications/some-id'
@@ -1407,8 +1407,8 @@ paths: 
                      properties:

                        zonalPresenceNotification:

                          $ref: '#/components/schemas/ZonalPresenceNotification'

                      example:

                        zonalPresenceNotification:

                      examples:

                        - zonalPresenceNotification:

                            clientCorrelator: '0123'

                            zoneId: 'zone01'

                            address: 'acr:10.0.0.1'
@@ -1446,8 +1446,8 @@ paths: 
                properties:

                  zonalTrafficSubscription:

                    $ref: '#/components/schemas/ZonalTrafficSubscription'

                example:

                  zonalTrafficSubscription:

                examples:

                  - zonalTrafficSubscription:

                      clientCorrelator: '0123'

                      callbackReference:

                        notifyURL: 'http://my.callback.com/location_notifications/some-id'
@@ -1483,8 +1483,8 @@ paths: 
              properties:

                zonalTrafficSubscription:

                  $ref: '#/components/schemas/ZonalTrafficSubscription'

              example:

                zonalTrafficSubscription:

              examples:

                - zonalTrafficSubscription:

                    clientCorrelator: '0123'

                    callbackReference:

                      notifyURL: 'http://my.callback.com/location_notifications/some-id'
@@ -1503,8 +1503,8 @@ paths: 
                properties:

                  zonalTrafficSubscription:

                    $ref: '#/components/schemas/ZonalTrafficSubscription'

              example:

                zonalTrafficSubscription:

                examples:

                  - zonalTrafficSubscription:

                      clientCorrelator: '0123'

                      callbackReference:

                        notifyURL: 'http://my.callback.com/location_notifications/some-id'
@@ -1567,8 +1567,8 @@ paths: 
                properties:

                  notificationSubscriptionList:

                    $ref: '#/components/schemas/NotificationSubscriptionList'

                example:

                  notificationSubscriptionList:

                examples:

                  - notificationSubscriptionList:

                      zoneStatusSubscription:

                      - clientCorrelator: '0123'

                        resourceURL: 'http://example.com/exampleAPI/location/v2/subscriptions/zoneStatus/subscription123'
@@ -1594,8 +1594,8 @@ paths: 
              properties:

                zoneStatusSubscription:

                  $ref: '#/components/schemas/ZoneStatusSubscription'

              example:

                zoneStatusSubscription:

              examples:

                - zoneStatusSubscription:

                    clientCorrelator: '0123'

                    callbackReference:

                      notifyURL: 'http://my.callback.com/location_notifications/some-id'
@@ -1612,8 +1612,8 @@ paths: 
                properties:

                  zoneStatusSubscription:

                    $ref: '#/components/schemas/ZoneStatusSubscription'

                example:

                  zoneStatusSubscription:

                examples:

                  - zoneStatusSubscription:

                      clientCorrelator: '0123'

                      callbackReference:

                        notifyURL: 'http://my.callback.com/location_notifications/some-id'
@@ -1650,8 +1650,8 @@ paths: 
                      properties:

                        zoneStatusNotification:

                          $ref: '#/components/schemas/ZoneStatusNotification'

                      example:

                        zoneStatusNotification:

                      examples:

                        - zoneStatusNotification:

                            clientCorrelator: '0123'

                            zoneId: 'zone01'

                            accessPointId: 'poa1'
@@ -1689,8 +1689,8 @@ paths: 
                properties:

                  zoneStatusSubscription:

                    $ref: '#/components/schemas/ZoneStatusSubscription'

                example:

                  zoneStatusSubscription:

                examples:

                  - zoneStatusSubscription:

                      clientCorrelator: '0123'

                      callbackReference:

                        notifyURL: 'http://my.callback.com/location_notifications/some-id'
@@ -1727,8 +1727,8 @@ paths: 
              properties:

                zoneStatusSubscription:

                  $ref: '#/components/schemas/ZoneStatusSubscription'

              example:

                zoneStatusSubscription:

              examples:

                - zoneStatusSubscription:

                    clientCorrelator: '0123'

                    callbackReference:

                      notifyURL: 'http://my.callback.com/location_notifications/some-id'
@@ -1748,8 +1748,8 @@ paths: 
                properties:

                  zoneStatusSubscription:

                    $ref: '#/components/schemas/ZoneStatusSubscription'

              example:

                zoneStatusSubscription:

                examples:

                  - zoneStatusSubscription:

                      clientCorrelator: '0123'

                      callbackReference:

                        notifyURL: 'http://my.callback.com/location_notifications/some-id'
@@ -1796,61 +1796,61 @@ paths: 
      x-swagger-router-controller: 'subscriptions'

components:

  responses:

    200:

    '200':

      description: 'OK'

    204:

    '204':

      description: 'No Content'

    400:

    '400':

      description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'

      content:

        application/problem+json:

          schema:

            $ref: '#/components/schemas/ProblemDetails'

    401:

    '401':

      description: 'Unauthorized :  used when the client did not submit credentials.'

      content:

        application/problem+json:

          schema:

            $ref: '#/components/schemas/ProblemDetails'

    403:

    '403':

      description: 'Forbidden :  operation is not allowed given the current status of the resource.'

      content:

        application/problem+json:

          schema:

            $ref: '#/components/schemas/ProblemDetails'

    404:

    '404':

      description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'

      content:

        application/problem+json:

          schema:

            $ref: '#/components/schemas/ProblemDetails'

    406:

    '406':

      description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'

      content:

        application/problem+json:

          schema:

            $ref: '#/components/schemas/ProblemDetails'

    412:

    '412':

      description: 'Precondition failed :  used when a condition has failed during conditional requests, e.g. when

        using ETags to avoid write conflicts when using PUT'

      content:

        application/problem+json:

          schema:

            $ref: '#/components/schemas/ProblemDetails'

    414:

    '414':

      description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is

        longer than the server is willing or able to process.'

      content:

        application/problem+json:

          schema:

            $ref: '#/components/schemas/ProblemDetails'

    415:

    '415':

      description: 'Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body.'

      content:

        application/problem+json:

          schema:

            $ref: '#/components/schemas/ProblemDetails'

    422:

    '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
@@ -1859,14 +1859,7 @@ components: 
        application/problem+json:

          schema:

            $ref: '#/components/schemas/ProblemDetails'

          example:

            application/problem+json:

              type: 'https://meAppServer.example.com/rni/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:

    '429':

      description: 'Too Many Requests : used when a rate limiter has triggered.'

      content:

        application/problem+json: