Commit 167fe488 authored by Ikram Haq's avatar Ikram Haq
Browse files

Remove unecessary code of distanceNotificationSubscription and... 

Remove unecessary code of distanceNotificationSubscription and circleNotificationSubscription (v2.2.1) and update the server stubs API version
parent d9f6dbfc

go-apps/meep-loc-serv/api/swagger.yaml

+102 −123
Original line number Diff line number Diff line
@@ -502,23 +502,13 @@ paths: 
              schema:

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

                example:

                notificationSubscriptionList:

                  distanceNotificationSubscription:

                    - clientCorrelator: '0123'

                      callbackReference:

                        callbackData: '1234'

                        notifyURL: 'http://clientApp.example.com/location_notifications/123456'

                      monitoredAddress:

                        - 'acr:10.0.0.1'

                        - 'acr:10.0.0.2'

                      checkImmediate: true

                      criteria: 'AllWithinDistance'

                      distance: 100

                      frequency: 10

                      referenceAddress: 'acr:10.0.0.3'

                      trackingAccuracy: 10

                      resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/sub123'

                  resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance'

                  - notificationSubscriptionList:

                      subscription:

                        - href: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123'

                          subscriptionType: 'UserDistanceSubscription'

                      resourceURL:

                          href: 'http://meAppServer.example.com/location/v2/subscriptions/distance'



    post:

      tags:

        - 'location'
@@ -533,43 +523,41 @@ paths: 
            schema:

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

            example:

              distanceNotificationSubscription:

                userDistanceSubscription:

                  subscriptionType: 'UserDistanceSubscription'

                  clientCorrelator: '0123'

                callbackReference:

                  callbackData: '1234'

                  notifyURL: 'http://clientApp.example.com/location_notifications/123456'

                  callbackReference: 'http://my.callback.com/user-distance/some-id'

                  referenceAddress:

                    - 'acr:10.0.0.3'

                  monitoredAddress:

                    - 'acr:10.0.0.1'

                    - 'acr:10.0.0.2'

                checkImmediate: true

                criteria: 'AllWithinDistance'

                  distance: 100

                frequency: 10

                referenceAddress: 'acr:10.0.0.3'

                  trackingAccuracy: 10

                  criteria: 'AllWithinDistance'

                  checkImmediate: true

      responses:

        '201':

          description: 'Successful subscription'

          content:

            application/json:

              schema:

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

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

                example:

                distanceNotificationSubscription:

                  userDistanceSubscription:

                    subscriptionType: 'UserDistanceSubscription'

                    clientCorrelator: '0123'

                  callbackReference:

                    callbackData: '1234'

                    notifyURL: 'http://clientApp.example.com/location_notifications/123456'

                    callbackReference: 'http://my.callback.com/user-distance/some-id'

                    referenceAddress:

                      - 'acr:10.0.0.3'

                    monitoredAddress:

                      - 'acr:10.0.0.1'

                      - 'acr:10.0.0.2'

                  checkImmediate: true

                  criteria: 'AllWithinDistance'

                    distance: 100

                  frequency: 10

                  referenceAddress: 'acr:10.0.0.3'

                    trackingAccuracy: 10

                  resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123'

                    criteria: 'AllWithinDistance'

                    checkImmediate: true



        '400':

          $ref: '#/components/responses/400'

        '401':
@@ -584,46 +572,40 @@ paths: 
          $ref: '#/components/responses/429'

      callbacks:

        notification:

          '{$request.body#/distanceNotificationSubscription.callbackReference.notifyURL}':

          '{$request.body#/userDistanceSubscription.callbackReference}':

            post:

              summary: 'Callback POST used to send a notification'

              description: 'Notification from Location service, content based on subscription type'

              description: 'Notification from Location service, content based user distance subscription type'

              operationId: distanceNotificationPOST

              requestBody:

                description: 'Subscription notification'

                description: 'User Distance Notification'

                required: true

                content:

                  application/json:

                    schema:

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

                      type: object

                      properties:

                        userDistanceNotification:

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

                      example:

                      subscriptionNotification:

                        distanceCriteria: 'AllWithinDistance'

                        isFinalNotification: false,

                        link:

                          rel: DistanceNotificationSubscription

                          href: 'http://meAppServer.example.com/location/v2/subscriptions/distance/sub123'

                        terminalLocation:

                          - address: 'acr:10.0.0.1'

                            currentLocation:

                              accuracy: 100

                              altitude: 1001.0

                              latitude: -80.86302

                              longitude: 41.277306

                        - userDistanceNotification:

                            notificationType: 'UserDistanceNotification'

                            timestamp:

                                seconds: 1483231138

                              seconds: 1673507343

                              nanoSeconds": 0

                            locationRetrievalStatus: 'Retrieved'

                          - address: 'acr:10.0.0.2'

                            currentLocation:

                              accuracy: 100

                              altitude: 1001.0

                              latitude: -80.86301

                              longitude: 41.277306

                            monitoredUsers: 

                              - user:

                                  address: 'acr:10.0.0.1'

                                  accessPointId: '001010000000000000000000000000001'

                                  zoneId: 'zone01'

                                  timestamp:

                                seconds: 1483231138

                                    seconds: 1673507343

                                    nanoSeconds": 0

                            locationRetrievalStatus: 'Retrieved'

                                resourceURL: 'http://meAppServer.example.com/location/v3/queries/users'

                            distanceEvent: 'AllWithinDistance'

                            _links:

                              subscription:

                                href: 'http://meAppServer.example.com/location/v3/subscriptions/distance/subscription123'

              responses:

                '204':

                  $ref: '#/components/responses/204'
@@ -632,8 +614,8 @@ paths: 
    get:

      tags:

        - 'location'

      summary: 'Retrieve subscription information'

      description: 'Get subscription information.'

      summary: 'Retrieve user distance subscription information'

      description: 'The GET method is used to retrieve information about user distance subscription subscription.'

      operationId: distanceSubGET

      parameters:

        - $ref: '#/components/parameters/Path.SubscrId'
@@ -643,23 +625,22 @@ paths: 
          content:

            application/json:

              schema:

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

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

              example:

                distanceNotificationSubscription:

                userDistanceSubscription:

                  subscriptionType: 'UserDistanceSubscription'

                  clientCorrelator: '0123'

                  callbackReference:

                    callbackData: '1234'

                    notifyURL: 'http://clientApp.example.com/location_notifications/123456'

                  callbackReference: 'http://my.callback.com/user-distance/some-id'

                  referenceAddress:

                    - 'acr:10.0.0.3'

                  monitoredAddress:

                    - 'acr:10.0.0.1'

                    - 'acr:10.0.0.2'

                  checkImmediate: true

                  criteria: 'AllWithinDistance'

                  distance: 100

                  frequency: 10

                  referenceAddress: 'acr:10.0.0.3'

                  trackingAccuracy: 10

                  resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123'

                  criteria: 'AllWithinDistance'

                  checkImmediate: true



        '400':

          $ref: '#/components/responses/400'

        '401':
@@ -676,8 +657,8 @@ paths: 
    put:

      tags:

        - 'location'

      summary: 'Updates a subscription information'

      description: 'Updates a subscription.'

      summary: 'Updates a user distance subscription information'

      description: 'The PUT method is used to update the existing user distance subscription.'

      operationId: distanceSubPUT

      requestBody:

        description: 'Subscription to be modified'
@@ -685,23 +666,22 @@ paths: 
        content:

          application/json:

            schema:

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

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

              example:

              distanceNotificationSubscription:

                userDistanceSubscription:

                  subscriptionType: 'UserDistanceSubscription'

                  clientCorrelator: '0123'

                callbackReference:

                  callbackData: '1234'

                  notifyURL: 'http://clientApp.example.com/location_notifications/123456'

                  callbackReference: 'http://my.callback.com/user-distance/some-id'

                  referenceAddress:

                    - 'acr:10.0.0.3'

                  monitoredAddress:

                    - 'acr:10.0.0.1'

                    - 'acr:10.0.0.2'

                checkImmediate: true

                criteria: 'AllWithinDistance'

                  distance: 100

                frequency: 10

                referenceAddress: 'acr:10.0.0.3'

                  trackingAccuracy: 10

                resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123'

                  criteria: 'AllWithinDistance'

                  checkImmediate: true



      parameters:

        - $ref: '#/components/parameters/Path.SubscrId'

      responses:
@@ -710,23 +690,22 @@ paths: 
          content:

            application/json:

              schema:

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

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

              example:

                distanceNotificationSubscription:

                userDistanceSubscription:

                  subscriptionType: 'UserDistanceSubscription'

                  clientCorrelator: '0123'

                  callbackReference:

                    callbackData: '1234'

                    notifyURL: 'http://clientApp.example.com/location_notifications/123456'

                  callbackReference: 'http://my.callback.com/user-distance/some-id'

                  referenceAddress:

                    - 'acr:10.0.0.3'

                  monitoredAddress:

                    - 'acr:10.0.0.1'

                    - 'acr:10.0.0.2'

                  checkImmediate: true

                  criteria: 'AllWithinDistance'

                  distance: 100

                  frequency: 10

                  referenceAddress: 'acr:10.0.0.3'

                  trackingAccuracy: 10

                  resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123'

                  criteria: 'AllWithinDistance'

                  checkImmediate: true



        '400':

          $ref: '#/components/responses/400'

        '401':
@@ -748,7 +727,7 @@ paths: 
      tags:

        - 'location'

      summary: 'Cancel a subscription'

      description: 'Method to delete a subscription.'

      description: 'The DELETE method is used to cancel the existing subscription.'

      operationId: distanceSubDELETE

      parameters:

        - $ref: '#/components/parameters/Path.SubscrId'

go-apps/meep-loc-serv/server/README.md

+1 −1
Original line number Diff line number Diff line
@@ -12,7 +12,7 @@ To see how to make this your own, look here: 


[README](https://github.com/swagger-api/swagger-codegen/blob/master/README.md)



- API version: 2.2.1

- API version: 3.1.1

- Build date: 2022-12-19T08:31:54.316740-05:00[America/Toronto]

go-apps/meep-loc-serv/server/api_location.go

+2 −16
Original line number Diff line number Diff line 
/*

 * Copyright (c) 2022  The AdvantEDGE Authors

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *    http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 *

 * AdvantEDGE Location API

 *

 * Location Service is AdvantEDGE's implementation of [ETSI MEC ISG MEC013 Location API](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/02.02.01_60/gs_mec013v020201p.pdf) <p>The API is based on the Open Mobile Alliance's specification RESTful Network API for Zonal Presence <p>[Copyright (c) ETSI 2017](https://forge.etsi.org/etsi-forge-copyright-notice.txt) <p>**Micro-service**<br>[meep-loc-serv](https://github.com/InterDigitalInc/AdvantEDGE/tree/master/go-apps/meep-loc-serv) <p>**Type & Usage**<br>Edge Service used by edge applications that want to get information about Users (UE) and Zone locations <p>**Note**<br>AdvantEDGE supports all of Location API endpoints (see below).

 * Location Service is AdvantEDGE's implementation of [ETSI MEC ISG MEC013 Location API](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/03.01.01_60/gs_mec013v030101p.pdf) <p>The API is based on the Open Mobile Alliance's specification RESTful Network API for Zonal Presence <p>[Copyright (c) ETSI 2017](https://forge.etsi.org/etsi-forge-copyright-notice.txt) <p>**Micro-service**<br>[meep-loc-serv](https://github.com/InterDigitalInc/AdvantEDGE/tree/master/go-apps/meep-loc-serv) <p>**Type & Usage**<br>Edge Service used by edge applications that want to get information about Users (UE) and Zone locations <p>**Note**<br>AdvantEDGE supports all of Location API endpoints (see below).

 *

 * API version: 2.2.1

 * API version: 3.1.1

 * Contact: AdvantEDGE@InterDigital.com

 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

 */

go-apps/meep-loc-serv/server/convert.go

+1 −44
Original line number Diff line number Diff line
@@ -206,7 +206,7 @@ func convertJsonToPeriodicSubscription(jsonInfo string) *PeriodicNotificationSub 
}

*/



func convertAreaCircleSubscriptionToJson(AreaSubs *UserAreaSubscription) string {

func convertAreaSubscriptionToJson(AreaSubs *UserAreaSubscription) string {



	jsonInfo, err := json.Marshal(*AreaSubs)

	if err != nil {
@@ -217,33 +217,6 @@ func convertAreaCircleSubscriptionToJson(AreaSubs *UserAreaSubscription) string 
	return string(jsonInfo)

}



/*

func convertJsonToAreaCircleSubscription(jsonInfo string) *CircleNotificationSubscription {



        if jsonInfo == "" {

                return nil

        }



	var circle CircleNotificationSubscription

	err := json.Unmarshal([]byte(jsonInfo), &circle)

	if err != nil {

		log.Error(err.Error())

		return nil

	}

	return &circle

}

*/

func convertDistanceSubscriptionToJson(distanceSubs *DistanceNotificationSubscription) string {



	jsonInfo, err := json.Marshal(*distanceSubs)

	if err != nil {

		log.Error(err.Error())

		return ""

	}



	return string(jsonInfo)

}



func convertDistanceSubscriptionToJson1(distanceSubs *UserDistanceSubscription) string {



	jsonInfo, err := json.Marshal(*distanceSubs)
@@ -255,22 +228,6 @@ func convertDistanceSubscriptionToJson1(distanceSubs *UserDistanceSubscription) 
	return string(jsonInfo)

}



/*

func convertJsonToDistanceSubscription(jsonInfo string) *DistanceNotificationSubscription {



        if jsonInfo == "" {

                return nil

        }



	var distance DistanceNotificationSubscription

	err := json.Unmarshal([]byte(jsonInfo), &distance)

	if err != nil {

		log.Error(err.Error())

		return nil

	}

	return &distance

}

*/

func convertStringToOperationStatus(opStatus string) OperationStatus {



	switch opStatus {

go-apps/meep-loc-serv/server/loc-serv.go

+9 −560

File changed.

Preview size limit exceeded, changes collapsed.