diff --git a/LocationAPI.json b/LocationAPI.json index c4739cbb55325c1fe9ee2fb55b1434376f99cb34..81e1d42bf151a0ad00c576ec2a15cb751a772722 100644 --- a/LocationAPI.json +++ b/LocationAPI.json @@ -3,18 +3,18 @@ "info": { "title": "Location API", "version": "1.1.1", - "description": "The ETSI MEC ISG MEC013 Location API described using OpenAPI. The API is based on the Open Mobile Alliance's specification RESTful Network API for Zonal Presence", + "description": "The ETSI MEC ISG MEC012 Location API described using OpenAPI. The API is based on the Open Mobile Alliance's specification RESTful Network API for Zonal Presence", "license": { "name": "ETSI Forge copyright notice", "url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt" } }, "externalDocs": { - "description": "ETSI GS MEC013 Location Service API, V1.1.1", + "description": "ETSI MEC013 V1.1.1 Location Service API", "url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/01.01.01_60/gs_mec013v010101p.pdf" }, "host": "127.0.0.1:8081", - "basePath": "/exampleAPI/location/v1/", + "basePath": "/exampleAPI/location/v1", "schemes": [ "http", "https" @@ -25,6 +25,17 @@ "produces": [ "application/json" ], + "tags": [ + { + "name": "zones" + }, + { + "name": "users" + }, + { + "name": "subscriptions" + } + ], "parameters": { "Body.UserTrackingSubscription": { "name": "userTrackingSubscription", @@ -106,6 +117,10 @@ "paths": { "/zones": { "get": { + "tags": [ + "zones" + ], + "operationId": "zonesGet", "description": "Used to get a list of identifiers for zones authorized for use by the application.", "produces": [ "application/json" @@ -148,16 +163,20 @@ } }, "/zones/{zoneId}": { + "parameters": [ + { + "$ref": "#/parameters/Path.ZoneId" + } + ], "get": { + "tags": [ + "zones" + ], + "operationId": "zonesGetById", "description": "Used to get the status of a zone.", "produces": [ "application/json" ], - "parameters": [ - { - "$ref": "#/parameters/Path.ZoneId" - } - ], "responses": { "200": { "description": "Successful response to a query regarding the status of a zone", @@ -184,15 +203,21 @@ } }, "/zones/{zoneId}/accessPoints": { + "parameters": [ + { + "$ref": "#/parameters/Path.ZoneId" + } + ], "get": { + "tags": [ + "zones" + ], + "operationId": "zonesByIdGetAps", "description": "Access point status can be retrieved for sets of access points matching attribute in the request.", "produces": [ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/Path.ZoneId" - }, { "$ref": "#/parameters/Query.InterestRealm" } @@ -264,19 +289,23 @@ } }, "/zones/{zoneId}/accessPoints/{accessPointId}": { + "parameters": [ + { + "$ref": "#/parameters/Path.ZoneId" + }, + { + "$ref": "#/parameters/Path.AccessPointId" + } + ], "get": { + "tags": [ + "zones" + ], + "operationId": "zonesByIdGetApsById", "description": "Access point status can be retrieved for sets of access points matching attribute in the request.", "produces": [ "application/json" ], - "parameters": [ - { - "$ref": "#/parameters/Path.ZoneId" - }, - { - "$ref": "#/parameters/Path.AccessPointId" - } - ], "responses": { "200": { "description": "Successful response to a query a named set of access point status request", @@ -311,6 +340,10 @@ }, "/users": { "get": { + "tags": [ + "users" + ], + "operationId": "usersGet", "description": "Users currently using a zone may be retrieved for sets of access points matching attribute in the request", "produces": [ "application/json" @@ -377,16 +410,20 @@ } }, "/users/{userId}": { + "parameters": [ + { + "$ref": "#/parameters/Path.UserId" + } + ], "get": { + "tags": [ + "users" + ], + "operationId": "usersGetById", "description": "Users currently using a zone may be retrieved for sets of access points matching attribute in the request", "produces": [ "application/json" ], - "parameters": [ - { - "$ref": "#/parameters/Path.UserId" - } - ], "responses": { "200": { "description": "Successful response to a query users within a zone request", @@ -420,6 +457,10 @@ }, "/subscriptions/zonalTraffic": { "get": { + "tags": [ + "subscriptions" + ], + "operationId": "zonalTrafficSubGet", "description": "This operation is used for retrieving all active subscriptions to zonal traffic change notifications.", "produces": [ "application/json" @@ -479,6 +520,10 @@ } }, "post": { + "tags": [ + "subscriptions" + ], + "operationId": "zonalTrafficSubPost", "description": "This operation is used for creating a new subscription to zonal traffic change notification.", "produces": [ "application/json" @@ -517,16 +562,20 @@ } }, "/subscriptions/zonalTraffic/{subscriptionId}": { + "parameters": [ + { + "$ref": "#/parameters/Path.SubscriptionId" + } + ], "get": { + "tags": [ + "subscriptions" + ], + "operationId": "zonalTrafficSubGetById", "description": "This operation is used for updating an individual subscription to zonal traffic change notification.", "produces": [ "application/json" ], - "parameters": [ - { - "$ref": "#/parameters/Path.SubscriptionId" - } - ], "responses": { "200": { "description": "Response to retrieve individual zonal traffic subscription", @@ -555,14 +604,15 @@ } }, "put": { + "tags": [ + "subscriptions" + ], + "operationId": "zonalTrafficSubPutById", "description": "This operation is used for updating an individual subscription to zonal traffic change notification.", "produces": [ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/Path.SubscriptionId" - }, { "$ref": "#/parameters/Body.ZonalTrafficSubscription" } @@ -595,15 +645,14 @@ } }, "delete": { + "tags": [ + "subscriptions" + ], + "operationId": "zonalTrafficSubDelById", "description": "This operation is used for cancelling a subscription and stopping corresponding notifications.", "produces": [ "application/json" ], - "parameters": [ - { - "$ref": "#/parameters/Path.SubscriptionId" - } - ], "responses": { "204": { "description": "No content" @@ -613,6 +662,10 @@ }, "/subscriptions/userTracking": { "get": { + "tags": [ + "subscriptions" + ], + "operationId": "userTrackingSubGet", "description": "This operation is used for retrieving all active subscriptions to user tracking change notifications.", "produces": [ "application/json" @@ -670,6 +723,10 @@ } }, "post": { + "tags": [ + "subscriptions" + ], + "operationId": "userTrackingSubPost", "description": "This operation is used for creating a new subscription to user tracking change notification", "produces": [ "application/json" @@ -707,16 +764,20 @@ } }, "/subscriptions/userTracking/{subscriptionId}": { + "parameters": [ + { + "$ref": "#/parameters/Path.SubscriptionId" + } + ], "get": { + "tags": [ + "subscriptions" + ], + "operationId": "userTrackingSubGetById", "description": "This operation is used for retrieving an individual subscription to user tracking change notification.", "produces": [ "application/json" ], - "parameters": [ - { - "$ref": "#/parameters/Path.SubscriptionId" - } - ], "responses": { "200": { "description": "Response to retrieve individual user tracking subscription", @@ -744,14 +805,15 @@ } }, "put": { + "tags": [ + "subscriptions" + ], + "operationId": "userTrackingSubPutById", "description": "This operation is used for updating an individual subscription to user tracking change notification.", "produces": [ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/Path.SubscriptionId" - }, { "$ref": "#/parameters/Body.UserTrackingSubscription" } @@ -783,15 +845,14 @@ } }, "delete": { + "tags": [ + "subscriptions" + ], + "operationId": "userTrackingSubDelById", "description": "This operation is used for retrieving an individual subscription to user tracking change notification.", "produces": [ "application/json" ], - "parameters": [ - { - "$ref": "#/parameters/Path.SubscriptionId" - } - ], "responses": { "204": { "description": "No Content" @@ -801,6 +862,10 @@ }, "/subscriptions/zonalStatus": { "get": { + "tags": [ + "subscriptions" + ], + "operationId": "zoneStatusGet", "description": "This operation is used for creating a new subscription to zone status change notification.", "produces": [ "application/json" @@ -860,6 +925,10 @@ } }, "post": { + "tags": [ + "subscriptions" + ], + "operationId": "zoneStatusPost", "description": "This operation is used for creating a new subscription to zone status change notification.", "produces": [ "application/json" @@ -898,16 +967,20 @@ } }, "/subscriptions/zoneStatus/{subscriptionId}": { + "parameters": [ + { + "$ref": "#/parameters/Path.SubscriptionId" + } + ], "get": { + "tags": [ + "subscriptions" + ], + "operationId": "zoneStatusGetById", "description": "This operation is used for retrieving an individual subscription to zone status change notification.", "produces": [ "application/json" ], - "parameters": [ - { - "$ref": "#/parameters/Path.SubscriptionId" - } - ], "responses": { "200": { "description": "Response to retrieve individual zone status subscription", @@ -936,14 +1009,15 @@ } }, "put": { + "tags": [ + "subscriptions" + ], + "operationId": "zoneStatusPutById", "description": "This operation is used for updating an individual subscription to zone status change notification.", "produces": [ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/Path.SubscriptionId" - }, { "$ref": "#/parameters/Body.ZoneStatusSubscription" } @@ -976,15 +1050,14 @@ } }, "delete": { + "tags": [ + "subscriptions" + ], + "operationId": "zoneStatusDelById", "description": "This operation is used for cancelling a subscription and stopping corresponding notifications.", "produces": [ "application/json" ], - "parameters": [ - { - "$ref": "#/parameters/Path.SubscriptionId" - } - ], "responses": { "204": { "description": "No content" diff --git a/LocationAPI.split.yaml b/LocationAPI.split.yaml index 40f20a6d64f44fb99ffb1307e4872cea4c048d7b..900b662c9035307808a4f45975c9e4475a4094bd 100644 --- a/LocationAPI.split.yaml +++ b/LocationAPI.split.yaml @@ -16,7 +16,7 @@ externalDocs: $ref: './externalDocs/index.yaml' host: 127.0.0.1:8081 -basePath: /exampleAPI/location/v1/ +basePath: /exampleAPI/location/v1 schemes: - http - https @@ -25,6 +25,12 @@ consumes: produces: - application/json +################################################################################ +# Tags # +################################################################################ +tags: + $ref: './tags/index.yaml' + ################################################################################ # Parameters # ################################################################################ diff --git a/LocationAPI.yaml b/LocationAPI.yaml index babead0540923becbb8f76cccf1b9dcc6c1b7d1b..42921e0d4ed2298c6cd20fa3c3ddd862c7ad143d 100644 --- a/LocationAPI.yaml +++ b/LocationAPI.yaml @@ -1,1056 +1,1116 @@ -swagger: '2.0' -info: - title: Location API - version: 1.1.1 - description: 'The ETSI MEC ISG MEC013 Location API described using OpenAPI. The API is based on the Open Mobile Alliance''s specification RESTful Network API for Zonal Presence' - license: - name: ETSI Forge copyright notice - url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt' -externalDocs: - description: ETSI GS MEC013 Location Service API, V1.1.1 - url: 'http://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/01.01.01_60/gs_mec013v010101p.pdf' -host: '127.0.0.1:8081' -basePath: /exampleAPI/location/v1/ -schemes: - - http - - https -consumes: - - application/json -produces: - - application/json -parameters: - Body.UserTrackingSubscription: - name: userTrackingSubscription - in: body - description: User Tracking Subscription - required: true - schema: - $ref: '#/definitions/UserTrackingSubscription' - Body.ZonalTrafficSubscription: - name: zonalTrafficSubscription - in: body - description: Zonal Traffic Subscription - required: true - schema: - $ref: '#/definitions/ZonalTrafficSubscription' - Body.ZoneStatusSubscription: - name: zoneStatusSubscription - in: body - description: Zone Status Subscription - required: true - schema: - $ref: '#/definitions/ZoneStatusSubscription' - Path.AccessPointId: - name: accessPointId - in: path - description: Access Point ID - required: true - type: string - Path.SubscriptionId: - name: subscriptionId - in: path - description: Subscription ID - required: true - type: string - Path.UserId: - name: userId - in: path - description: User ID - required: true - type: string - Path.ZoneId: - name: zoneId - in: path - description: Zone ID - required: true - type: string - Query.AccessPointId: - name: accessPointId - in: query - description: 'Identifier of access point, reference "definitions" for string format' - required: false - type: string - Query.InterestRealm: - name: interestRealm - in: query - description: 'Interest realm of access point (e.g. geographical area, a type of industry etc.).' - required: false - type: string - Query.ZoneId: - name: zoneId - in: query - description: Zone ID - required: true - type: string -paths: - /zones: - get: - description: Used to get a list of identifiers for zones authorized for use by the application. - produces: - - application/json - responses: - '200': - description: Successful response to a query regarding the status of a zone - schema: - properties: - zoneList: - $ref: '#/definitions/ZoneList' - examples: - application/json: - zoneList: - zone: - - zoneId: zone01 - numberOfAccessPoints: '3' - numberOfUnserviceableAccessPoints: '1' - numberOfUsers: '10' - resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01' - - zoneId: zone02 - numberOfAccessPoints: '12' - numberOfUnserviceableAccessPoints: '0' - numberOfUsers: '36' - resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone02' - resourceURL: 'http://example.com/exampleAPI/location/v1/zones' - '/zones/{zoneId}': - get: - description: Used to get the status of a zone. - produces: - - application/json - parameters: - - $ref: '#/parameters/Path.ZoneId' - responses: - '200': - description: Successful response to a query regarding the status of a zone - schema: - properties: - zoneInfo: - $ref: '#/definitions/ZoneInfo' - examples: - application/json: - zoneInfo: - zoneId: zone01 - numberOfAccessPoints: '3' - numberOfUnserviceableAccessPoints: '1' - numberOfUsers: '10' - resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01' - '/zones/{zoneId}/accessPoints': - get: - description: Access point status can be retrieved for sets of access points matching attribute in the request. - produces: - - application/json - parameters: - - $ref: '#/parameters/Path.ZoneId' - - $ref: '#/parameters/Query.InterestRealm' - responses: - '200': - description: Successful response to a query a named set of access point status request - schema: - properties: - accessPointList: - $ref: '#/definitions/AccessPointList' - examples: - application/json: - accessPointList: - zoneId: zone01 - accessPoint: - - accessPointId: '001010000000000000000000000000001' - locationInfo: - latitude: '90.123' - longitude: '80.123' - altitude: '10.0' - accuracy: '0' - connectionType: Macro - operationStatus: Serviceable - numberOfUsers: '5' - interestRealm: LA - resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints/ap001' - - accessPointId: '001010000000000000000000000000010' - locationInfo: - latitude: '91.123' - longitude: '81.123' - altitude: '12.0' - accuracy: '1' - connectionType: Macro - operationStatus: Unserviceable - numberOfUsers: '0' - interestRealm: DC - resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints/ap002' - - accessPointId: '001010000000000000000000000000011' - locationInfo: - latitude: '93.123' - longitude: '83.123' - altitude: '16.0' - accuracy: '3' - connectionType: Macro - operationStatus: Serviceable - numberOfUsers: '5' - interestRealm: NJ - resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints/ap003' - resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints' - '/zones/{zoneId}/accessPoints/{accessPointId}': - get: - description: Access point status can be retrieved for sets of access points matching attribute in the request. - produces: - - application/json - parameters: - - $ref: '#/parameters/Path.ZoneId' - - $ref: '#/parameters/Path.AccessPointId' - responses: - '200': - description: Successful response to a query a named set of access point status request - schema: - properties: - accessPointInfo: - $ref: '#/definitions/AccessPointInfo' - examples: - application/json: - accessPointInfo: - accessPointId: '001010000000000000000000000000001' - locationInfo: - latitude: '90.123' - longitude: '80.123' - altitude: '10.0' - accuracy: '0' - connectionType: Macro - operationStatus: Serviceable - numberOfUsers: '5' - interestRealm: LA - resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone001/accessPoints/ap001' - /users: - get: - description: Users currently using a zone may be retrieved for sets of access points matching attribute in the request - produces: - - application/json - parameters: - - $ref: '#/parameters/Query.ZoneId' - - $ref: '#/parameters/Query.AccessPointId' - responses: - '200': - description: Successful response to a query users within a zone request - schema: - properties: - userList: - $ref: '#/definitions/UserList' - examples: - application/json: - userList: - user: - - address: 'acr:192.0.2.1' - accessPointId: '001010000000000000000000000000001' - zoneId: zone01 - resourceURL: 'http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.1' - - address: 'acr:192.0.2.2' - accessPointId: '001010000000000000000000000000001' - zoneId: zone01 - resourceURL: 'http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.2' - - address: 'acr:192.0.2.3' - accessPointId: '001010000000000000000000000000010' - zoneId: zone01 - resourceURL: 'http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.3' - - address: 'acr:192.0.2.4' - accessPointId: '001010000000000000000000000000001' - zoneId: zone02 - resourceURL: 'http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.4' - - address: 'acr:192.0.2.5' - accessPointId: '001010000000000000000000000000010' - zoneId: zone02 - resourceURL: 'http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.5' - resourceURL: 'http://example.com/exampleAPI/location/v1/users' - '/users/{userId}': - get: - description: Users currently using a zone may be retrieved for sets of access points matching attribute in the request - produces: - - application/json - parameters: - - $ref: '#/parameters/Path.UserId' - responses: - '200': - description: Successful response to a query users within a zone request - schema: - properties: - userInfo: - $ref: '#/definitions/UserInfo' - examples: - application/json: - userInfo: - address: 'acr:192.0.2.1' - accessPointId: '001010000000000000000000000000001' - zoneId: zone01 - resourceURL: 'http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.1' - locationInfo: - latitude: '90.123' - longitude: '80.123' - altitude: '10.0' - accuracy: '0' - contextLocationInfo: GroundFloor - /subscriptions/zonalTraffic: - get: - description: This operation is used for retrieving all active subscriptions to zonal traffic change notifications. - produces: - - application/json - responses: - '200': - description: Response to retrieve zonal traffic subscriptions - schema: - type: object - properties: - notificationSubscriptionList: - type: object - properties: - zonalTrafficSubscription: - type: array - items: - $ref: '#/definitions/ZonalTrafficSubscription' - resourceURL: - $ref: '#/definitions/ResourceURL' - examples: - application/json: - notificationSubscriptionList: - zonalTrafficSubscription: - - clientCorrelator: '0123' - resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription123' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - zoneId: zone01 - interestRealm: LA - userEventCriteria: Transferring - - clientCorrelator: '0124' - resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription124' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123457' - zoneId: zone02 - interestRealm: LA - userEventCriteria: Transferring - resourceURL: 'http://example.com/exampleAPI/location/v1/zonalTraffic' - post: - description: This operation is used for creating a new subscription to zonal traffic change notification. - produces: - - application/json - parameters: - - $ref: '#/parameters/Body.ZonalTrafficSubscription' - responses: - '201': - description: Response to create new zonal traffic subscription - schema: - properties: - zonalTrafficSubscription: - $ref: '#/definitions/ZonalTrafficSubscription' - examples: - application/json: - zonalTrafficSubscription: - clientCorrelator: '0123' - resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription123' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - zoneId: zone01 - interestRealm: LA - userEventCriteria: Transferring - '/subscriptions/zonalTraffic/{subscriptionId}': - get: - description: This operation is used for updating an individual subscription to zonal traffic change notification. - produces: - - application/json - parameters: - - $ref: '#/parameters/Path.SubscriptionId' - responses: - '200': - description: Response to retrieve individual zonal traffic subscription - schema: - properties: - zonalTrafficSubscription: - $ref: '#/definitions/ZonalTrafficSubscription' - examples: - application/json: - zonalTrafficSubscription: - clientCorrelator: '0123' - resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription123' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - zoneId: zone01 - interestRealm: LA - userEventCriteria: Transferring - put: - description: This operation is used for updating an individual subscription to zonal traffic change notification. - produces: - - application/json - parameters: - - $ref: '#/parameters/Path.SubscriptionId' - - $ref: '#/parameters/Body.ZonalTrafficSubscription' - responses: - '200': - description: Response to update individual zonal traffic subscription - schema: - properties: - zonalTrafficSubscription: - $ref: '#/definitions/ZonalTrafficSubscription' - examples: - application/json: - zonalTrafficSubscription: - clientCorrelator: '0123' - resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription123' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - zoneId: zone01 - interestRealm: LA - userEventCriteria: Transferring - delete: - description: This operation is used for cancelling a subscription and stopping corresponding notifications. - produces: - - application/json - parameters: - - $ref: '#/parameters/Path.SubscriptionId' - responses: - '204': - description: No content - /subscriptions/userTracking: - get: - description: This operation is used for retrieving all active subscriptions to user tracking change notifications. - produces: - - application/json - responses: - '200': - description: Response to retrieve user tracking subscriptions - schema: - type: object - properties: - notificationSubscriptionList: - type: object - properties: - userTrackingSubscription: - type: array - items: - $ref: '#/definitions/UserTrackingSubscription' - resourceURL: - $ref: '#/definitions/ResourceURL' - examples: - application/json: - notificationSubscriptionList: - userTrackingSubscription: - - clientCorrelator: '0123' - resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - address: 'acr:192.0.2.1' - userEventCriteria: Transferring - - clientCorrelator: '0124' - resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription124' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - address: 'acr:192.0.2.2' - userEventCriteria: Transferring - resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/userTracking' - post: - description: This operation is used for creating a new subscription to user tracking change notification - produces: - - application/json - parameters: - - $ref: '#/parameters/Body.UserTrackingSubscription' - responses: - '201': - description: Response to create new user tracking subscription - schema: - properties: - userTrackingSubscription: - $ref: '#/definitions/UserTrackingSubscription' - examples: - application/json: - userTrackingSubscription: - clientCorrelator: '0123' - resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - address: 'acr:192.0.2.1' - userEventCriteria: Transferring - '/subscriptions/userTracking/{subscriptionId}': - get: - description: This operation is used for retrieving an individual subscription to user tracking change notification. - produces: - - application/json - parameters: - - $ref: '#/parameters/Path.SubscriptionId' - responses: - '200': - description: Response to retrieve individual user tracking subscription - schema: - properties: - userTrackingSubscription: - $ref: '#/definitions/UserTrackingSubscription' - examples: - application/json: - userTrackingSubscription: - clientCorrelator: '0123' - resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - address: 'acr:192.0.2.1' - userEventCriteria: Transferring - put: - description: This operation is used for updating an individual subscription to user tracking change notification. - produces: - - application/json - parameters: - - $ref: '#/parameters/Path.SubscriptionId' - - $ref: '#/parameters/Body.UserTrackingSubscription' - responses: - '200': - description: Response to update individual user tracking subscription - schema: - properties: - userTrackingSubscription: - $ref: '#/definitions/UserTrackingSubscription' - examples: - application/json: - userTrackingSubscription: - clientCorrelator: '0123' - resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - address: 'acr:192.0.2.1' - userEventCriteria: Transferring - delete: - description: This operation is used for retrieving an individual subscription to user tracking change notification. - produces: - - application/json - parameters: - - $ref: '#/parameters/Path.SubscriptionId' - responses: - '204': - description: No Content - /subscriptions/zonalStatus: - get: - description: This operation is used for creating a new subscription to zone status change notification. - produces: - - application/json - responses: - '200': - description: Response to retrieve zone status subscriptions - schema: - type: object - properties: - notificationSubscriptionList: - type: object - properties: - zonalTrafficSubscription: - type: array - items: - $ref: '#/definitions/ZoneStatusSubscription' - resourceURL: - $ref: '#/definitions/ResourceURL' - examples: - application/json: - notificationSubscriptionList: - zoneStatusSubscription: - - clientCorrelator: '0123' - resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription123' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - zoneId: zone01 - numberOfUsersZoneThreshold: '500' - operationStatus: Serviceable - - clientCorrelator: '0124' - resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription124' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123457' - zoneId: zone02 - numberOfUsersAPThreshold: '50' - operationStatus: Serviceable - resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus' - post: - description: This operation is used for creating a new subscription to zone status change notification. - produces: - - application/json - parameters: - - $ref: '#/parameters/Body.ZoneStatusSubscription' - responses: - '201': - description: Response to create new zone status subscription - schema: - properties: - zonalTrafficSubscription: - $ref: '#/definitions/ZoneStatusSubscription' - examples: - application/json: - zoneStatusSubscription: - clientCorrelator: '0123' - resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription123' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - zoneId: zone01 - numberOfUsersZoneThreshold: '500' - operationStatus: Serviceable - '/subscriptions/zoneStatus/{subscriptionId}': - get: - description: This operation is used for retrieving an individual subscription to zone status change notification. - produces: - - application/json - parameters: - - $ref: '#/parameters/Path.SubscriptionId' - responses: - '200': - description: Response to retrieve individual zone status subscription - schema: - properties: - zoneStatusSubscription: - $ref: '#/definitions/ZoneStatusSubscription' - examples: - application/json: - zoneStatusSubscription: - clientCorrelator: '0123' - resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription123' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - zoneId: zone01 - numberOfUsersZoneThreshold: '500' - operationStatus: Serviceable - put: - description: This operation is used for updating an individual subscription to zone status change notification. - produces: - - application/json - parameters: - - $ref: '#/parameters/Path.SubscriptionId' - - $ref: '#/parameters/Body.ZoneStatusSubscription' - responses: - '200': - description: Response to update individual zone status subscription - schema: - properties: - zoneStatusSubscription: - $ref: '#/definitions/ZoneStatusSubscription' - examples: - application/json: - zoneStatusSubscription: - clientCorrelator: '0123' - resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription123' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - zoneId: zone01 - numberOfUsersZoneThreshold: '500' - operationStatus: Serviceable - delete: - description: This operation is used for cancelling a subscription and stopping corresponding notifications. - produces: - - application/json - parameters: - - $ref: '#/parameters/Path.SubscriptionId' - responses: - '204': - description: No content -definitions: - AccessPointId: - description: 'Identifier of access point, (reference ETSI TS 129 171). Where the E-CGI is made up of the PLMN and Cell Identity (28 bit string). Then the PLMN is made up of the 3 digit MCC & 2 or 3 digit MNC. The Cell Portion is an optional element' - type: string - example: '001010000000000000000000000000001' - AccessPointInfo: - description: A type containing access point information. - type: object - required: - - accessPointId - - connectionType - - operationStatus - - numberOfUsers - - resourceURL - properties: - accessPointId: - $ref: '#/definitions/AccessPointId' - locationInfo: - $ref: '#/definitions/LocationInfo' - connectionType: - $ref: '#/definitions/ConnectionType' - operationStatus: - $ref: '#/definitions/OperationStatus' - numberOfUsers: - $ref: '#/definitions/NumberOfUsers' - timezone: - $ref: '#/definitions/Timezone' - interestRealm: - $ref: '#/definitions/InterestRealm' - resourceURL: - $ref: '#/definitions/ResourceURL' - AccessPointList: - description: A type containing list of access points. - type: object - required: - - zoneId - - resourceURL - properties: - zoneId: - $ref: '#/definitions/ZoneId' - accessPoint: - description: Collection of the access point information list. - type: array - items: - $ref: '#/definitions/AccessPointInfo' - resourceURL: - $ref: '#/definitions/ResourceURL' - Address: - description: 'Address of user (e.g. "sip" URI, "tel" URI, "acr" URI).' - type: string - format: uri - example: 'acr:192.0.2.1' - AncillaryInfo: - description: Reserved for future use. - type: string - CallbackData: - description: 'CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common].' - type: string - example: '1234' - CallbackReference: - description: Notification callback definition. - type: object - required: - - notifyURL - properties: - notifyURL: - $ref: '#/definitions/NotifyURL' - ClientCorrelator: - description: 'Uniquely identifies this create subscription request. If there is a communication failure during the request, using the same clientCorrelator when retrying the request allows the operator to avoid creating a duplicate subscription.' - type: string - example: '0123' - ConnectionType: - description: The connection type for the access point - type: string - enum: - - LTE-femto - - Smallcell - - LTE-smallcell - - Wifi - - Pico - - Micro - - Macro - - Wimax - - Unknown - example: Macro - ContextLocationInfo: - description: 'Contextual information of a user location (e.g., aisle, floor, room number, etc.)' - type: string - example: GroundFloor - CurrentAccessPointId: - description: Zone ID - type: string - example: zone01 - Duration: - description: 'Period (in seconds) of time notifications are provided for. If set to "0" (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications. This element MAY be given by the client during resource creation in order to signal the desired lifetime of the subscription. The server MUST return in this element the period of time for which the subscription will still be valid.' - type: string - example: '0' - InterestRealm: - description: 'Interest realm of access point (e.g. geographical area, a type of industry etc.).' - type: string - example: LA - Link: - description: Link to other resources - type: object - required: - - rel - - href - properties: - rel: - description: Describes the relationship between the URI and the resource. - type: object - format: string - href: - description: URI - type: object - format: anyURI - LocationInfo: - description: 'A type containing location information with latitude, longitude and altitude, in addition the accuracy of the information are provided.' - type: object - required: - - latitude - - longitude - - accuracy - properties: - latitude: - type: number - format: float - example: '80.123' - longitude: - type: number - format: float - example: '70.123' - altitude: - type: number - format: float - example: '10.0' - accuracy: - type: integer - format: int32 - example: '10' - NotifyURL: - description: The URL of your own listener application. - type: string - format: url - example: 'http://clientApp.example.com/location_notifications/123456' - NumberOfAccessPoints: - description: The number of access points within the zone - type: integer - format: uint32 - example: '10' - NumberOfUnserviceableAccessPoints: - description: Number of inoperable access points within the zone. - type: integer - format: uint32 - example: '9' - NumberOfUsers: - description: The number of users currently on the access point. - type: integer - format: uint32 - example: '7' - NumberOfUsersAPThreshold: - description: Threshold number of users in an access point which if crossed shall cause a notification. - type: integer - format: uint32 - example: '20' - NumberOfUsersInAP: - description: This element shall be present when ZoneStatusSubscription includes numberOfUsersAPThreshold element and the number of users in an access point exceeds the threshold defined in the subscription. - type: integer - format: uint32 - example: '12' - NumberOfUsersInZone: - description: This element shall be present when ZoneStatusSubscription includes numberOfUsersZoneThreshold element and the number of users in a zone exceeds the threshold defined in this subscription. - type: integer - format: uint32 - example: '20' - NumberOfUsersZoneThreshold: - description: Threshold number of users in a zone which if crossed shall cause a notification. - type: integer - format: uint32 - example: '40' - OperationStatus: - description: The operation status of the access point - type: string - enum: - - Serviceable - - Unserviceable - - Unknown - example: Serviceable - PreviousAccessPointId: - description: Zone ID - type: string - example: zone02 - ResourceURL: - description: Self referring URL. - type: string - format: uri - example: 'http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123' - Timestamp: - description: Indicates the time of day for zonal presence notification. - type: string - format: date-time - example: '2017-01-01T02:51:43Z' - Timezone: - description: Time zone of access point - type: string - format: date-time - example: '2017-01-01T02:51:43Z' - UserEventCriteria: - description: 'List of user event values to generate notifications for (these apply to address specified). If this element is missing, a notification is requested to be generated for any change in user event.' - type: array - items: - $ref: '#/definitions/UserEventType' - UserEventType: - description: User event - type: string - enum: - - Entering - - Leaving - - Transferring - example: Entering - UserInfo: - description: A type containing user information. - type: object - required: - - address - - accessPointId - - zoneId - - resourceURL - properties: - address: - $ref: '#/definitions/Address' - accessPointId: - $ref: '#/definitions/AccessPointId' - zoneId: - $ref: '#/definitions/ZoneId' - resourceURL: - $ref: '#/definitions/ResourceURL' - locationInfo: - $ref: '#/definitions/LocationInfo' - contextLocationInfo: - $ref: '#/definitions/ContextLocationInfo' - ancillaryInfo: - $ref: '#/definitions/AncillaryInfo' - UserList: - description: A type containing list of users. - type: object - required: - - resourceURL - properties: - user: - description: Collection of the zone information list. - type: array - items: - $ref: '#/definitions/UserInfo' - resourceURL: - $ref: '#/definitions/ResourceURL' - UserTrackingSubscription: - description: A type containing user tracking subscription. - type: object - required: - - callbackReference - - address - properties: - clientCorrelator: - $ref: '#/definitions/ClientCorrelator' - callbackReference: - $ref: '#/definitions/CallbackReference' - address: - $ref: '#/definitions/Address' - userEventCriteria: - $ref: '#/definitions/UserEventCriteria' - resourceURL: - $ref: '#/definitions/ResourceURL' - ZonalPresenceNotification: - description: A type containing zonal presence notification - type: object - required: - - zoneId - - address - - userEventType - - currentAccessPointId - - timestamp - properties: - callbackData: - $ref: '#/definitions/CallbackData' - zoneId: - $ref: '#/definitions/ZoneId' - address: - $ref: '#/definitions/Address' - interestRealm: - $ref: '#/definitions/InterestRealm' - userEventType: - $ref: '#/definitions/UserEventType' - currentAccessPointId: - $ref: '#/definitions/CurrentAccessPointId' - previousAccessPointId: - $ref: '#/definitions/PreviousAccessPointId' - timestamp: - $ref: '#/definitions/Timestamp' - link: - description: Link to other resources that are in relationship with this notification. The server SHOULD include a link to the related subscription. No other links are required or suggested by this specification. - type: array - items: - $ref: '#/definitions/Link' - example: 'rel="ZonalTrafficSubscription" href="http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/sub123"/' - ZonalTrafficSubscription: - description: A type containing zonal traffic subscription - type: object - required: - - callbackReference - - zoneId - properties: - clientCorrelator: - $ref: '#/definitions/ClientCorrelator' - callbackReference: - $ref: '#/definitions/CallbackReference' - zoneId: - $ref: '#/definitions/ZoneId' - interestRealm: - description: 'Interest realms of access points within a zone (e.g. geographical area, a type of industry etc.).' - type: array - items: - $ref: '#/definitions/InterestRealm' - userEventCriteria: - description: 'List of user event values to generate notifications for (these apply to zone identifier or all interest realms within zone identifier specified). If this element is missing, a notification is requested to be generated for any change in user event.' - type: array - items: - $ref: '#/definitions/UserEventType' - duration: - $ref: '#/definitions/Duration' - resourceURL: - $ref: '#/definitions/ResourceURL' - ZoneId: - description: Identifier of zone - type: string - example: zone01 - ZoneInfo: - description: A type containing zone information. - type: object - required: - - zoneId - - numberOfAccessPoints - - numberOfUnservicableAccessPoints - - numberOfUsers - - resourceURL - properties: - zoneId: - $ref: '#/definitions/ZoneId' - numberOfAccessPoints: - $ref: '#/definitions/NumberOfAccessPoints' - numberOfUnservicableAccessPoints: - $ref: '#/definitions/NumberOfUnserviceableAccessPoints' - numberOfUsers: - $ref: '#/definitions/NumberOfUsers' - resourceURL: - $ref: '#/definitions/ResourceURL' - ZoneList: - description: Collection of the zone information list. - type: object - required: - - resourceURL - properties: - zone: - description: Collection of the zone information list. - type: array - items: - $ref: '#/definitions/ZoneInfo' - resourceURL: - $ref: '#/definitions/ResourceURL' - ZoneStatusNotification: - description: A type containing zone status notification. - type: object - required: - - zoneId - - timestamp - properties: - callbackData: - $ref: '#/definitions/CallbackData' - zoneId: - $ref: '#/definitions/ZoneId' - accessPointId: - $ref: '#/definitions/AccessPointId' - numberOfUsersInZone: - $ref: '#/definitions/NumberOfUsersInZone' - numberOfUsersInAP: - $ref: '#/definitions/NumberOfUsersInAP' - operationStatus: - $ref: '#/definitions/OperationStatus' - timestamp: - $ref: '#/definitions/Timestamp' - link: - description: Link to other resources that are in relationship with this notification. The server SHOULD include a link to the related subscription. No other links are required or suggested by this specification. - type: array - items: - $ref: '#/definitions/Link' - example: 'rel="ZonalStatusSubscription" href="http://example.com/exampleAPI/location/v1/subscriptions/zonalStatus/sub123"' - ZoneStatusSubscription: - description: A type containing zone status subscription. - type: object - required: - - callbackReference - - zoneId - properties: - clientCorrelator: - $ref: '#/definitions/ClientCorrelator' - resourceURL: - $ref: '#/definitions/ResourceURL' - callbackReference: - $ref: '#/definitions/CallbackReference' - zoneId: - $ref: '#/definitions/ZoneId' - numberOfUsersZoneThreshold: - $ref: '#/definitions/NumberOfUsersZoneThreshold' - numberOfUsersAPThreshold: - $ref: '#/definitions/NumberOfUsersAPThreshold' - operationStatus: - description: List of operation status values to generate notifications for (these apply to all access points within a zone). - type: array - items: - $ref: '#/definitions/OperationStatus' +swagger: '2.0' +info: + title: Location API + version: 1.1.1 + description: The ETSI MEC ISG MEC012 Location API described using OpenAPI. The API is based on the Open Mobile Alliance's specification RESTful Network API for Zonal Presence + license: + name: ETSI Forge copyright notice + url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt' +externalDocs: + description: ETSI MEC013 V1.1.1 Location Service API + url: 'http://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/01.01.01_60/gs_mec013v010101p.pdf' +host: '127.0.0.1:8081' +basePath: /exampleAPI/location/v1 +schemes: + - http + - https +consumes: + - application/json +produces: + - application/json +tags: + - name: zones + - name: users + - name: subscriptions +parameters: + Body.UserTrackingSubscription: + name: userTrackingSubscription + in: body + description: User Tracking Subscription + required: true + schema: + $ref: '#/definitions/UserTrackingSubscription' + Body.ZonalTrafficSubscription: + name: zonalTrafficSubscription + in: body + description: Zonal Traffic Subscription + required: true + schema: + $ref: '#/definitions/ZonalTrafficSubscription' + Body.ZoneStatusSubscription: + name: zoneStatusSubscription + in: body + description: Zone Status Subscription + required: true + schema: + $ref: '#/definitions/ZoneStatusSubscription' + Path.AccessPointId: + name: accessPointId + in: path + description: Access Point ID + required: true + type: string + Path.SubscriptionId: + name: subscriptionId + in: path + description: Subscription ID + required: true + type: string + Path.UserId: + name: userId + in: path + description: User ID + required: true + type: string + Path.ZoneId: + name: zoneId + in: path + description: Zone ID + required: true + type: string + Query.AccessPointId: + name: accessPointId + in: query + description: 'Identifier of access point, reference "definitions" for string format' + required: false + type: string + Query.InterestRealm: + name: interestRealm + in: query + description: 'Interest realm of access point (e.g. geographical area, a type of industry etc.).' + required: false + type: string + Query.ZoneId: + name: zoneId + in: query + description: Zone ID + required: true + type: string +paths: + /zones: + get: + tags: + - zones + operationId: zonesGet + description: Used to get a list of identifiers for zones authorized for use by the application. + produces: + - application/json + responses: + '200': + description: Successful response to a query regarding the status of a zone + schema: + properties: + zoneList: + $ref: '#/definitions/ZoneList' + examples: + application/json: + zoneList: + zone: + - zoneId: zone01 + numberOfAccessPoints: '3' + numberOfUnserviceableAccessPoints: '1' + numberOfUsers: '10' + resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01' + - zoneId: zone02 + numberOfAccessPoints: '12' + numberOfUnserviceableAccessPoints: '0' + numberOfUsers: '36' + resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone02' + resourceURL: 'http://example.com/exampleAPI/location/v1/zones' + '/zones/{zoneId}': + parameters: + - $ref: '#/parameters/Path.ZoneId' + get: + tags: + - zones + operationId: zonesGetById + description: Used to get the status of a zone. + produces: + - application/json + responses: + '200': + description: Successful response to a query regarding the status of a zone + schema: + properties: + zoneInfo: + $ref: '#/definitions/ZoneInfo' + examples: + application/json: + zoneInfo: + zoneId: zone01 + numberOfAccessPoints: '3' + numberOfUnserviceableAccessPoints: '1' + numberOfUsers: '10' + resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01' + '/zones/{zoneId}/accessPoints': + parameters: + - $ref: '#/parameters/Path.ZoneId' + get: + tags: + - zones + operationId: zonesByIdGetAps + description: Access point status can be retrieved for sets of access points matching attribute in the request. + produces: + - application/json + parameters: + - $ref: '#/parameters/Query.InterestRealm' + responses: + '200': + description: Successful response to a query a named set of access point status request + schema: + properties: + accessPointList: + $ref: '#/definitions/AccessPointList' + examples: + application/json: + accessPointList: + zoneId: zone01 + accessPoint: + - accessPointId: '001010000000000000000000000000001' + locationInfo: + latitude: '90.123' + longitude: '80.123' + altitude: '10.0' + accuracy: '0' + connectionType: Macro + operationStatus: Serviceable + numberOfUsers: '5' + interestRealm: LA + resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints/ap001' + - accessPointId: '001010000000000000000000000000010' + locationInfo: + latitude: '91.123' + longitude: '81.123' + altitude: '12.0' + accuracy: '1' + connectionType: Macro + operationStatus: Unserviceable + numberOfUsers: '0' + interestRealm: DC + resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints/ap002' + - accessPointId: '001010000000000000000000000000011' + locationInfo: + latitude: '93.123' + longitude: '83.123' + altitude: '16.0' + accuracy: '3' + connectionType: Macro + operationStatus: Serviceable + numberOfUsers: '5' + interestRealm: NJ + resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints/ap003' + resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints' + '/zones/{zoneId}/accessPoints/{accessPointId}': + parameters: + - $ref: '#/parameters/Path.ZoneId' + - $ref: '#/parameters/Path.AccessPointId' + get: + tags: + - zones + operationId: zonesByIdGetApsById + description: Access point status can be retrieved for sets of access points matching attribute in the request. + produces: + - application/json + responses: + '200': + description: Successful response to a query a named set of access point status request + schema: + properties: + accessPointInfo: + $ref: '#/definitions/AccessPointInfo' + examples: + application/json: + accessPointInfo: + accessPointId: '001010000000000000000000000000001' + locationInfo: + latitude: '90.123' + longitude: '80.123' + altitude: '10.0' + accuracy: '0' + connectionType: Macro + operationStatus: Serviceable + numberOfUsers: '5' + interestRealm: LA + resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone001/accessPoints/ap001' + /users: + get: + tags: + - users + operationId: usersGet + description: Users currently using a zone may be retrieved for sets of access points matching attribute in the request + produces: + - application/json + parameters: + - $ref: '#/parameters/Query.ZoneId' + - $ref: '#/parameters/Query.AccessPointId' + responses: + '200': + description: Successful response to a query users within a zone request + schema: + properties: + userList: + $ref: '#/definitions/UserList' + examples: + application/json: + userList: + user: + - address: 'acr:192.0.2.1' + accessPointId: '001010000000000000000000000000001' + zoneId: zone01 + resourceURL: 'http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.1' + - address: 'acr:192.0.2.2' + accessPointId: '001010000000000000000000000000001' + zoneId: zone01 + resourceURL: 'http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.2' + - address: 'acr:192.0.2.3' + accessPointId: '001010000000000000000000000000010' + zoneId: zone01 + resourceURL: 'http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.3' + - address: 'acr:192.0.2.4' + accessPointId: '001010000000000000000000000000001' + zoneId: zone02 + resourceURL: 'http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.4' + - address: 'acr:192.0.2.5' + accessPointId: '001010000000000000000000000000010' + zoneId: zone02 + resourceURL: 'http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.5' + resourceURL: 'http://example.com/exampleAPI/location/v1/users' + '/users/{userId}': + parameters: + - $ref: '#/parameters/Path.UserId' + get: + tags: + - users + operationId: usersGetById + description: Users currently using a zone may be retrieved for sets of access points matching attribute in the request + produces: + - application/json + responses: + '200': + description: Successful response to a query users within a zone request + schema: + properties: + userInfo: + $ref: '#/definitions/UserInfo' + examples: + application/json: + userInfo: + address: 'acr:192.0.2.1' + accessPointId: '001010000000000000000000000000001' + zoneId: zone01 + resourceURL: 'http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.1' + locationInfo: + latitude: '90.123' + longitude: '80.123' + altitude: '10.0' + accuracy: '0' + contextLocationInfo: GroundFloor + /subscriptions/zonalTraffic: + get: + tags: + - subscriptions + operationId: zonalTrafficSubGet + description: This operation is used for retrieving all active subscriptions to zonal traffic change notifications. + produces: + - application/json + responses: + '200': + description: Response to retrieve zonal traffic subscriptions + schema: + type: object + properties: + notificationSubscriptionList: + type: object + properties: + zonalTrafficSubscription: + type: array + items: + $ref: '#/definitions/ZonalTrafficSubscription' + resourceURL: + $ref: '#/definitions/ResourceURL' + examples: + application/json: + notificationSubscriptionList: + zonalTrafficSubscription: + - clientCorrelator: '0123' + resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription123' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + zoneId: zone01 + interestRealm: LA + userEventCriteria: Transferring + - clientCorrelator: '0124' + resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription124' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123457' + zoneId: zone02 + interestRealm: LA + userEventCriteria: Transferring + resourceURL: 'http://example.com/exampleAPI/location/v1/zonalTraffic' + post: + tags: + - subscriptions + operationId: zonalTrafficSubPost + description: This operation is used for creating a new subscription to zonal traffic change notification. + produces: + - application/json + parameters: + - $ref: '#/parameters/Body.ZonalTrafficSubscription' + responses: + '201': + description: Response to create new zonal traffic subscription + schema: + properties: + zonalTrafficSubscription: + $ref: '#/definitions/ZonalTrafficSubscription' + examples: + application/json: + zonalTrafficSubscription: + clientCorrelator: '0123' + resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription123' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + zoneId: zone01 + interestRealm: LA + userEventCriteria: Transferring + '/subscriptions/zonalTraffic/{subscriptionId}': + parameters: + - $ref: '#/parameters/Path.SubscriptionId' + get: + tags: + - subscriptions + operationId: zonalTrafficSubGetById + description: This operation is used for updating an individual subscription to zonal traffic change notification. + produces: + - application/json + responses: + '200': + description: Response to retrieve individual zonal traffic subscription + schema: + properties: + zonalTrafficSubscription: + $ref: '#/definitions/ZonalTrafficSubscription' + examples: + application/json: + zonalTrafficSubscription: + clientCorrelator: '0123' + resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription123' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + zoneId: zone01 + interestRealm: LA + userEventCriteria: Transferring + put: + tags: + - subscriptions + operationId: zonalTrafficSubPutById + description: This operation is used for updating an individual subscription to zonal traffic change notification. + produces: + - application/json + parameters: + - $ref: '#/parameters/Body.ZonalTrafficSubscription' + responses: + '200': + description: Response to update individual zonal traffic subscription + schema: + properties: + zonalTrafficSubscription: + $ref: '#/definitions/ZonalTrafficSubscription' + examples: + application/json: + zonalTrafficSubscription: + clientCorrelator: '0123' + resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription123' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + zoneId: zone01 + interestRealm: LA + userEventCriteria: Transferring + delete: + tags: + - subscriptions + operationId: zonalTrafficSubDelById + description: This operation is used for cancelling a subscription and stopping corresponding notifications. + produces: + - application/json + responses: + '204': + description: No content + /subscriptions/userTracking: + get: + tags: + - subscriptions + operationId: userTrackingSubGet + description: This operation is used for retrieving all active subscriptions to user tracking change notifications. + produces: + - application/json + responses: + '200': + description: Response to retrieve user tracking subscriptions + schema: + type: object + properties: + notificationSubscriptionList: + type: object + properties: + userTrackingSubscription: + type: array + items: + $ref: '#/definitions/UserTrackingSubscription' + resourceURL: + $ref: '#/definitions/ResourceURL' + examples: + application/json: + notificationSubscriptionList: + userTrackingSubscription: + - clientCorrelator: '0123' + resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + address: 'acr:192.0.2.1' + userEventCriteria: Transferring + - clientCorrelator: '0124' + resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription124' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + address: 'acr:192.0.2.2' + userEventCriteria: Transferring + resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/userTracking' + post: + tags: + - subscriptions + operationId: userTrackingSubPost + description: This operation is used for creating a new subscription to user tracking change notification + produces: + - application/json + parameters: + - $ref: '#/parameters/Body.UserTrackingSubscription' + responses: + '201': + description: Response to create new user tracking subscription + schema: + properties: + userTrackingSubscription: + $ref: '#/definitions/UserTrackingSubscription' + examples: + application/json: + userTrackingSubscription: + clientCorrelator: '0123' + resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + address: 'acr:192.0.2.1' + userEventCriteria: Transferring + '/subscriptions/userTracking/{subscriptionId}': + parameters: + - $ref: '#/parameters/Path.SubscriptionId' + get: + tags: + - subscriptions + operationId: userTrackingSubGetById + description: This operation is used for retrieving an individual subscription to user tracking change notification. + produces: + - application/json + responses: + '200': + description: Response to retrieve individual user tracking subscription + schema: + properties: + userTrackingSubscription: + $ref: '#/definitions/UserTrackingSubscription' + examples: + application/json: + userTrackingSubscription: + clientCorrelator: '0123' + resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + address: 'acr:192.0.2.1' + userEventCriteria: Transferring + put: + tags: + - subscriptions + operationId: userTrackingSubPutById + description: This operation is used for updating an individual subscription to user tracking change notification. + produces: + - application/json + parameters: + - $ref: '#/parameters/Body.UserTrackingSubscription' + responses: + '200': + description: Response to update individual user tracking subscription + schema: + properties: + userTrackingSubscription: + $ref: '#/definitions/UserTrackingSubscription' + examples: + application/json: + userTrackingSubscription: + clientCorrelator: '0123' + resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + address: 'acr:192.0.2.1' + userEventCriteria: Transferring + delete: + tags: + - subscriptions + operationId: userTrackingSubDelById + description: This operation is used for retrieving an individual subscription to user tracking change notification. + produces: + - application/json + responses: + '204': + description: No Content + /subscriptions/zonalStatus: + get: + tags: + - subscriptions + operationId: zoneStatusGet + description: This operation is used for creating a new subscription to zone status change notification. + produces: + - application/json + responses: + '200': + description: Response to retrieve zone status subscriptions + schema: + type: object + properties: + notificationSubscriptionList: + type: object + properties: + zonalTrafficSubscription: + type: array + items: + $ref: '#/definitions/ZoneStatusSubscription' + resourceURL: + $ref: '#/definitions/ResourceURL' + examples: + application/json: + notificationSubscriptionList: + zoneStatusSubscription: + - clientCorrelator: '0123' + resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription123' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + zoneId: zone01 + numberOfUsersZoneThreshold: '500' + operationStatus: Serviceable + - clientCorrelator: '0124' + resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription124' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123457' + zoneId: zone02 + numberOfUsersAPThreshold: '50' + operationStatus: Serviceable + resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus' + post: + tags: + - subscriptions + operationId: zoneStatusPost + description: This operation is used for creating a new subscription to zone status change notification. + produces: + - application/json + parameters: + - $ref: '#/parameters/Body.ZoneStatusSubscription' + responses: + '201': + description: Response to create new zone status subscription + schema: + properties: + zonalTrafficSubscription: + $ref: '#/definitions/ZoneStatusSubscription' + examples: + application/json: + zoneStatusSubscription: + clientCorrelator: '0123' + resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription123' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + zoneId: zone01 + numberOfUsersZoneThreshold: '500' + operationStatus: Serviceable + '/subscriptions/zoneStatus/{subscriptionId}': + parameters: + - $ref: '#/parameters/Path.SubscriptionId' + get: + tags: + - subscriptions + operationId: zoneStatusGetById + description: This operation is used for retrieving an individual subscription to zone status change notification. + produces: + - application/json + responses: + '200': + description: Response to retrieve individual zone status subscription + schema: + properties: + zoneStatusSubscription: + $ref: '#/definitions/ZoneStatusSubscription' + examples: + application/json: + zoneStatusSubscription: + clientCorrelator: '0123' + resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription123' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + zoneId: zone01 + numberOfUsersZoneThreshold: '500' + operationStatus: Serviceable + put: + tags: + - subscriptions + operationId: zoneStatusPutById + description: This operation is used for updating an individual subscription to zone status change notification. + produces: + - application/json + parameters: + - $ref: '#/parameters/Body.ZoneStatusSubscription' + responses: + '200': + description: Response to update individual zone status subscription + schema: + properties: + zoneStatusSubscription: + $ref: '#/definitions/ZoneStatusSubscription' + examples: + application/json: + zoneStatusSubscription: + clientCorrelator: '0123' + resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription123' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + zoneId: zone01 + numberOfUsersZoneThreshold: '500' + operationStatus: Serviceable + delete: + tags: + - subscriptions + operationId: zoneStatusDelById + description: This operation is used for cancelling a subscription and stopping corresponding notifications. + produces: + - application/json + responses: + '204': + description: No content +definitions: + AccessPointId: + description: 'Identifier of access point, (reference ETSI TS 129 171). Where the E-CGI is made up of the PLMN and Cell Identity (28 bit string). Then the PLMN is made up of the 3 digit MCC & 2 or 3 digit MNC. The Cell Portion is an optional element' + type: string + example: '001010000000000000000000000000001' + AccessPointInfo: + description: A type containing access point information. + type: object + required: + - accessPointId + - connectionType + - operationStatus + - numberOfUsers + - resourceURL + properties: + accessPointId: + $ref: '#/definitions/AccessPointId' + locationInfo: + $ref: '#/definitions/LocationInfo' + connectionType: + $ref: '#/definitions/ConnectionType' + operationStatus: + $ref: '#/definitions/OperationStatus' + numberOfUsers: + $ref: '#/definitions/NumberOfUsers' + timezone: + $ref: '#/definitions/Timezone' + interestRealm: + $ref: '#/definitions/InterestRealm' + resourceURL: + $ref: '#/definitions/ResourceURL' + AccessPointList: + description: A type containing list of access points. + type: object + required: + - zoneId + - resourceURL + properties: + zoneId: + $ref: '#/definitions/ZoneId' + accessPoint: + description: Collection of the access point information list. + type: array + items: + $ref: '#/definitions/AccessPointInfo' + resourceURL: + $ref: '#/definitions/ResourceURL' + Address: + description: 'Address of user (e.g. "sip" URI, "tel" URI, "acr" URI).' + type: string + format: uri + example: 'acr:192.0.2.1' + AncillaryInfo: + description: Reserved for future use. + type: string + CallbackData: + description: 'CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common].' + type: string + example: '1234' + CallbackReference: + description: Notification callback definition. + type: object + required: + - notifyURL + properties: + notifyURL: + $ref: '#/definitions/NotifyURL' + ClientCorrelator: + description: 'Uniquely identifies this create subscription request. If there is a communication failure during the request, using the same clientCorrelator when retrying the request allows the operator to avoid creating a duplicate subscription.' + type: string + example: '0123' + ConnectionType: + description: The connection type for the access point + type: string + enum: + - Femto + - LTE-femto + - Smallcell + - LTE-smallcell + - Wifi + - Pico + - Micro + - Macro + - Wimax + - Unknown + example: Macro + ContextLocationInfo: + description: 'Contextual information of a user location (e.g., aisle, floor, room number, etc.)' + type: string + example: GroundFloor + CurrentAccessPointId: + description: Zone ID + type: string + example: zone01 + Duration: + description: 'Period (in seconds) of time notifications are provided for. If set to "0" (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications. This element MAY be given by the client during resource creation in order to signal the desired lifetime of the subscription. The server MUST return in this element the period of time for which the subscription will still be valid.' + type: string + example: '0' + InterestRealm: + description: 'Interest realm of access point (e.g. geographical area, a type of industry etc.).' + type: string + example: LA + Link: + description: Link to other resources + type: object + required: + - rel + - href + properties: + rel: + description: Describes the relationship between the URI and the resource. + type: object + format: string + href: + description: URI + type: object + format: anyURI + LocationInfo: + description: 'A type containing location information with latitude, longitude and altitude, in addition the accuracy of the information are provided.' + type: object + required: + - latitude + - longitude + - accuracy + properties: + latitude: + type: number + format: float + example: '80.123' + longitude: + type: number + format: float + example: '70.123' + altitude: + type: number + format: float + example: '10.0' + accuracy: + type: integer + format: int32 + example: '10' + NotifyURL: + description: The URL of your own listener application. + type: string + format: url + example: 'http://clientApp.example.com/location_notifications/123456' + NumberOfAccessPoints: + description: The number of access points within the zone + type: integer + format: uint32 + example: '10' + NumberOfUnserviceableAccessPoints: + description: Number of inoperable access points within the zone. + type: integer + format: uint32 + example: '9' + NumberOfUsers: + description: The number of users currently on the access point. + type: integer + format: uint32 + example: '7' + NumberOfUsersAPThreshold: + description: Threshold number of users in an access point which if crossed shall cause a notification. + type: integer + format: uint32 + example: '20' + NumberOfUsersInAP: + description: This element shall be present when ZoneStatusSubscription includes numberOfUsersAPThreshold element and the number of users in an access point exceeds the threshold defined in the subscription. + type: integer + format: uint32 + example: '12' + NumberOfUsersInZone: + description: This element shall be present when ZoneStatusSubscription includes numberOfUsersZoneThreshold element and the number of users in a zone exceeds the threshold defined in this subscription. + type: integer + format: uint32 + example: '20' + NumberOfUsersZoneThreshold: + description: Threshold number of users in a zone which if crossed shall cause a notification. + type: integer + format: uint32 + example: '40' + OperationStatus: + description: The operation status of the access point + type: string + enum: + - Serviceable + - Unserviceable + - Unknown + example: Serviceable + PreviousAccessPointId: + description: Zone ID + type: string + example: zone02 + ResourceURL: + description: Self referring URL. + type: string + format: uri + example: 'http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123' + Timestamp: + description: Indicates the time of day for zonal presence notification. + type: string + format: date-time + example: '2017-01-01T02:51:43Z' + Timezone: + description: Time zone of access point + type: string + format: date-time + example: '2017-01-01T02:51:43Z' + UserEventCriteria: + description: 'List of user event values to generate notifications for (these apply to address specified). If this element is missing, a notification is requested to be generated for any change in user event.' + type: array + items: + $ref: '#/definitions/UserEventType' + UserEventType: + description: User event + type: string + enum: + - Entering + - Leaving + - Transferring + example: Entering + UserInfo: + description: A type containing user information. + type: object + required: + - address + - accessPointId + - zoneId + - resourceURL + properties: + address: + $ref: '#/definitions/Address' + accessPointId: + $ref: '#/definitions/AccessPointId' + zoneId: + $ref: '#/definitions/ZoneId' + resourceURL: + $ref: '#/definitions/ResourceURL' + locationInfo: + $ref: '#/definitions/LocationInfo' + contextLocationInfo: + $ref: '#/definitions/ContextLocationInfo' + ancillaryInfo: + $ref: '#/definitions/AncillaryInfo' + UserList: + description: A type containing list of users. + type: object + required: + - resourceURL + properties: + user: + description: Collection of the zone information list. + type: array + items: + $ref: '#/definitions/UserInfo' + resourceURL: + $ref: '#/definitions/ResourceURL' + UserTrackingSubscription: + description: A type containing user tracking subscription. + type: object + required: + - callbackReference + - address + properties: + clientCorrelator: + $ref: '#/definitions/ClientCorrelator' + callbackReference: + $ref: '#/definitions/CallbackReference' + address: + $ref: '#/definitions/Address' + userEventCriteria: + $ref: '#/definitions/UserEventCriteria' + resourceURL: + $ref: '#/definitions/ResourceURL' + ZonalPresenceNotification: + description: A type containing zonal presence notification + type: object + required: + - zoneId + - address + - userEventType + - currentAccessPointId + - timestamp + properties: + callbackData: + $ref: '#/definitions/CallbackData' + zoneId: + $ref: '#/definitions/ZoneId' + address: + $ref: '#/definitions/Address' + interestRealm: + $ref: '#/definitions/InterestRealm' + userEventType: + $ref: '#/definitions/UserEventType' + currentAccessPointId: + $ref: '#/definitions/CurrentAccessPointId' + previousAccessPointId: + $ref: '#/definitions/PreviousAccessPointId' + timestamp: + $ref: '#/definitions/Timestamp' + link: + description: Link to other resources that are in relationship with this notification. The server SHOULD include a link to the related subscription. No other links are required or suggested by this specification. + type: array + items: + $ref: '#/definitions/Link' + example: 'rel="ZonalTrafficSubscription" href="http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/sub123"/' + ZonalTrafficSubscription: + description: A type containing zonal traffic subscription + type: object + required: + - callbackReference + - zoneId + properties: + clientCorrelator: + $ref: '#/definitions/ClientCorrelator' + callbackReference: + $ref: '#/definitions/CallbackReference' + zoneId: + $ref: '#/definitions/ZoneId' + interestRealm: + description: 'Interest realms of access points within a zone (e.g. geographical area, a type of industry etc.).' + type: array + items: + $ref: '#/definitions/InterestRealm' + userEventCriteria: + description: 'List of user event values to generate notifications for (these apply to zone identifier or all interest realms within zone identifier specified). If this element is missing, a notification is requested to be generated for any change in user event.' + type: array + items: + $ref: '#/definitions/UserEventType' + duration: + $ref: '#/definitions/Duration' + resourceURL: + $ref: '#/definitions/ResourceURL' + ZoneId: + description: Identifier of zone + type: string + example: zone01 + ZoneInfo: + description: A type containing zone information. + type: object + required: + - zoneId + - numberOfAccessPoints + - numberOfUnservicableAccessPoints + - numberOfUsers + - resourceURL + properties: + zoneId: + $ref: '#/definitions/ZoneId' + numberOfAccessPoints: + $ref: '#/definitions/NumberOfAccessPoints' + numberOfUnservicableAccessPoints: + $ref: '#/definitions/NumberOfUnserviceableAccessPoints' + numberOfUsers: + $ref: '#/definitions/NumberOfUsers' + resourceURL: + $ref: '#/definitions/ResourceURL' + ZoneList: + description: Collection of the zone information list. + type: object + required: + - resourceURL + properties: + zone: + description: Collection of the zone information list. + type: array + items: + $ref: '#/definitions/ZoneInfo' + resourceURL: + $ref: '#/definitions/ResourceURL' + ZoneStatusNotification: + description: A type containing zone status notification. + type: object + required: + - zoneId + - timestamp + properties: + callbackData: + $ref: '#/definitions/CallbackData' + zoneId: + $ref: '#/definitions/ZoneId' + accessPointId: + $ref: '#/definitions/AccessPointId' + numberOfUsersInZone: + $ref: '#/definitions/NumberOfUsersInZone' + numberOfUsersInAP: + $ref: '#/definitions/NumberOfUsersInAP' + operationStatus: + $ref: '#/definitions/OperationStatus' + timestamp: + $ref: '#/definitions/Timestamp' + link: + description: Link to other resources that are in relationship with this notification. The server SHOULD include a link to the related subscription. No other links are required or suggested by this specification. + type: array + items: + $ref: '#/definitions/Link' + example: 'rel="ZonalStatusSubscription" href="http://example.com/exampleAPI/location/v1/subscriptions/zonalStatus/sub123"' + ZoneStatusSubscription: + description: A type containing zone status subscription. + type: object + required: + - callbackReference + - zoneId + properties: + clientCorrelator: + $ref: '#/definitions/ClientCorrelator' + resourceURL: + $ref: '#/definitions/ResourceURL' + callbackReference: + $ref: '#/definitions/CallbackReference' + zoneId: + $ref: '#/definitions/ZoneId' + numberOfUsersZoneThreshold: + $ref: '#/definitions/NumberOfUsersZoneThreshold' + numberOfUsersAPThreshold: + $ref: '#/definitions/NumberOfUsersAPThreshold' + operationStatus: + description: List of operation status values to generate notifications for (these apply to all access points within a zone). + type: array + items: + $ref: '#/definitions/OperationStatus' diff --git a/paths/SubsUserTrackId.yaml b/paths/SubsUserTrackId.yaml index 941cd059864bfc4b16a7c8fa13a8848055f3344e..ae9c6834a150d5159bc59c2b5e9ecc933fae255b 100644 --- a/paths/SubsUserTrackId.yaml +++ b/paths/SubsUserTrackId.yaml @@ -1,3 +1,6 @@ +parameters: +- $ref: '#/parameters/Path.SubscriptionId' + get: $ref: ./SubsUserTrackId_Get.yaml diff --git a/paths/SubsUserTrackId_Del.yaml b/paths/SubsUserTrackId_Del.yaml index 766658409f00ca6ee8ceed321d05bed37c150714..104a98b743b838fb65f8f3acedb3997e10522f90 100644 --- a/paths/SubsUserTrackId_Del.yaml +++ b/paths/SubsUserTrackId_Del.yaml @@ -1,10 +1,10 @@ +tags: +- subscriptions +operationId: userTrackingSubDelById description: This operation is used for retrieving an individual subscription to user tracking change notification. produces: - application/json -parameters: -- $ref: '#/parameters/Path.SubscriptionId' - responses: 204: description: No Content \ No newline at end of file diff --git a/paths/SubsUserTrackId_Get.yaml b/paths/SubsUserTrackId_Get.yaml index 07445e75965c8f33e14415a41ec2042323a9dc35..f5c128fae24eb8cda03c8bb7391c62f719184d22 100644 --- a/paths/SubsUserTrackId_Get.yaml +++ b/paths/SubsUserTrackId_Get.yaml @@ -1,10 +1,10 @@ +tags: +- subscriptions +operationId: userTrackingSubGetById description: This operation is used for retrieving an individual subscription to user tracking change notification. produces: - application/json -parameters: -- $ref: '#/parameters/Path.SubscriptionId' - responses: 200: description: Response to retrieve individual user tracking subscription @@ -12,7 +12,6 @@ responses: properties: userTrackingSubscription: $ref: '#/definitions/UserTrackingSubscription' - examples: application/json: $ref: '../examples/UserTrackingSubscription.json' \ No newline at end of file diff --git a/paths/SubsUserTrackId_Put.yaml b/paths/SubsUserTrackId_Put.yaml index ab57b4852c2ff5ffb1cbddf05e649230f5f179e5..798f19ab11bac184f3df49c7609c210ffb402a1c 100644 --- a/paths/SubsUserTrackId_Put.yaml +++ b/paths/SubsUserTrackId_Put.yaml @@ -1,11 +1,12 @@ +tags: +- subscriptions +operationId: userTrackingSubPutById description: This operation is used for updating an individual subscription to user tracking change notification. produces: - application/json parameters: -- $ref: '#/parameters/Path.SubscriptionId' - $ref: '#/parameters/Body.UserTrackingSubscription' - responses: 200: description: Response to update individual user tracking subscription @@ -13,7 +14,6 @@ responses: properties: userTrackingSubscription: $ref: '#/definitions/UserTrackingSubscription' - examples: application/json: $ref: '../examples/UserTrackingSubscription.json' \ No newline at end of file diff --git a/paths/SubsUserTrack_Get.yaml b/paths/SubsUserTrack_Get.yaml index a02692cb141f84e9a2dc15d543562894b8566280..56be5eaea0140e6c34ba343796ae90c0ca092c3a 100644 --- a/paths/SubsUserTrack_Get.yaml +++ b/paths/SubsUserTrack_Get.yaml @@ -1,8 +1,10 @@ +tags: +- subscriptions +operationId: userTrackingSubGet description: This operation is used for retrieving all active subscriptions to user tracking change notifications. produces: - application/json - responses: 200: description: Response to retrieve user tracking subscriptions @@ -18,7 +20,6 @@ responses: $ref: '#/definitions/UserTrackingSubscription' resourceURL: $ref: '#/definitions/ResourceURL' - examples: application/json: $ref: '../examples/NotiSubsListUserTrac.json' \ No newline at end of file diff --git a/paths/SubsUserTrack_Post.yaml b/paths/SubsUserTrack_Post.yaml index 8097c74549cf4cbfbd5163073de98a133300daf1..5ff56696f659678f65c12e5ab9439215179dc191 100644 --- a/paths/SubsUserTrack_Post.yaml +++ b/paths/SubsUserTrack_Post.yaml @@ -1,10 +1,12 @@ +tags: +- subscriptions +operationId: userTrackingSubPost description: This operation is used for creating a new subscription to user tracking change notification produces: - application/json parameters: - $ref: '#/parameters/Body.UserTrackingSubscription' - responses: 201: description: Response to create new user tracking subscription @@ -12,7 +14,6 @@ responses: properties: userTrackingSubscription: $ref: '#/definitions/UserTrackingSubscription' - examples: application/json: $ref: '../examples/UserTrackingSubscription.json' diff --git a/paths/SubsZonalTrafId.yaml b/paths/SubsZonalTrafId.yaml index bc9d3aa7ca6a0b199e636128c334bbbabe024c90..af610806d9e407321856af21a732b6dff64364e2 100644 --- a/paths/SubsZonalTrafId.yaml +++ b/paths/SubsZonalTrafId.yaml @@ -1,3 +1,6 @@ +parameters: +- $ref: '#/parameters/Path.SubscriptionId' + get: $ref: ./SubsZonalTrafId_Get.yaml diff --git a/paths/SubsZonalTrafId_Del.yaml b/paths/SubsZonalTrafId_Del.yaml index 69317c2b6efc8c97e1439cbbfdee5a4011887fde..d05a7164002e9a22c9f2d3cadf679b9dc98ab8be 100644 --- a/paths/SubsZonalTrafId_Del.yaml +++ b/paths/SubsZonalTrafId_Del.yaml @@ -1,10 +1,10 @@ +tags: +- subscriptions +operationId: zonalTrafficSubDelById description: This operation is used for cancelling a subscription and stopping corresponding notifications. produces: - application/json -parameters: -- $ref: '#/parameters/Path.SubscriptionId' - responses: 204: description: No content \ No newline at end of file diff --git a/paths/SubsZonalTrafId_Get.yaml b/paths/SubsZonalTrafId_Get.yaml index 904eef93cc92f934c9aa7fb5902f0b6cc4a1bc64..85ffefcd0b6eb8736dfc7520775e6a37fa427bf4 100644 --- a/paths/SubsZonalTrafId_Get.yaml +++ b/paths/SubsZonalTrafId_Get.yaml @@ -1,10 +1,10 @@ +tags: +- subscriptions +operationId: zonalTrafficSubGetById description: This operation is used for updating an individual subscription to zonal traffic change notification. produces: - application/json -parameters: -- $ref: '#/parameters/Path.SubscriptionId' - responses: 200: description: Response to retrieve individual zonal traffic subscription @@ -12,7 +12,6 @@ responses: properties: zonalTrafficSubscription: $ref: '#/definitions/ZonalTrafficSubscription' - examples: application/json: $ref: '../examples/ZonalTrafficSubscription.json' \ No newline at end of file diff --git a/paths/SubsZonalTrafId_Put.yaml b/paths/SubsZonalTrafId_Put.yaml index 41cc486732944ed7f790daa7be3644fe1a900cf6..8bd167549502a5308fc1f5f99e23c9c640aa78a1 100644 --- a/paths/SubsZonalTrafId_Put.yaml +++ b/paths/SubsZonalTrafId_Put.yaml @@ -1,11 +1,12 @@ +tags: +- subscriptions +operationId: zonalTrafficSubPutById description: This operation is used for updating an individual subscription to zonal traffic change notification. produces: - application/json parameters: -- $ref: '#/parameters/Path.SubscriptionId' - $ref: '#/parameters/Body.ZonalTrafficSubscription' - responses: 200: description: Response to update individual zonal traffic subscription @@ -13,7 +14,6 @@ responses: properties: zonalTrafficSubscription: $ref: '#/definitions/ZonalTrafficSubscription' - examples: application/json: $ref: '../examples/ZonalTrafficSubscription.json' \ No newline at end of file diff --git a/paths/SubsZonalTraf_Get.yaml b/paths/SubsZonalTraf_Get.yaml index 7afc5248adae26157d295e64d53b2d6545db34c5..4a1943d8b2b761dbf84b4f6652ba7ad9578bb697 100644 --- a/paths/SubsZonalTraf_Get.yaml +++ b/paths/SubsZonalTraf_Get.yaml @@ -1,8 +1,10 @@ +tags: +- subscriptions +operationId: zonalTrafficSubGet description: This operation is used for retrieving all active subscriptions to zonal traffic change notifications. produces: - application/json - responses: 200: description: Response to retrieve zonal traffic subscriptions @@ -18,7 +20,6 @@ responses: $ref: '#/definitions/ZonalTrafficSubscription' resourceURL: $ref: '#/definitions/ResourceURL' - examples: application/json: $ref: '../examples/NotiSubsListZonaTraf.json' \ No newline at end of file diff --git a/paths/SubsZonalTraf_Post.yaml b/paths/SubsZonalTraf_Post.yaml index ad5f2bc43ac05c6e283551fbea78c25e77394c4f..4a1c4f105558916b24e72a1a03a5d6bff491899a 100644 --- a/paths/SubsZonalTraf_Post.yaml +++ b/paths/SubsZonalTraf_Post.yaml @@ -1,10 +1,12 @@ +tags: +- subscriptions +operationId: zonalTrafficSubPost description: This operation is used for creating a new subscription to zonal traffic change notification. produces: - application/json parameters: -- $ref: '#/parameters/Body.ZonalTrafficSubscription' - +- $ref: '#/parameters/Body.ZonalTrafficSubscription' responses: 201: description: Response to create new zonal traffic subscription @@ -12,7 +14,6 @@ responses: properties: zonalTrafficSubscription: $ref: '#/definitions/ZonalTrafficSubscription' - examples: application/json: $ref: '../examples/ZonalTrafficSubscription.json' \ No newline at end of file diff --git a/paths/SubsZoneStatId.yaml b/paths/SubsZoneStatId.yaml index 7507a83d9a43ce71b3382e59546e57149e27818f..42e57f4368956535cddc40c7864a764d052a8539 100644 --- a/paths/SubsZoneStatId.yaml +++ b/paths/SubsZoneStatId.yaml @@ -1,3 +1,6 @@ +parameters: +- $ref: '#/parameters/Path.SubscriptionId' + get: $ref: ./SubsZoneStatId_Get.yaml diff --git a/paths/SubsZoneStatId_Del.yaml b/paths/SubsZoneStatId_Del.yaml index 69317c2b6efc8c97e1439cbbfdee5a4011887fde..d72dc75175cdef5c5f753b53cc8b8fffe2858f85 100644 --- a/paths/SubsZoneStatId_Del.yaml +++ b/paths/SubsZoneStatId_Del.yaml @@ -1,10 +1,10 @@ +tags: +- subscriptions +operationId: zoneStatusDelById description: This operation is used for cancelling a subscription and stopping corresponding notifications. produces: - application/json -parameters: -- $ref: '#/parameters/Path.SubscriptionId' - responses: 204: description: No content \ No newline at end of file diff --git a/paths/SubsZoneStatId_Get.yaml b/paths/SubsZoneStatId_Get.yaml index bf09fe0b9cb43dd92da1c32cabc25e18795c456d..917bbd4081e4f7a217f589464624e0fb192b7849 100644 --- a/paths/SubsZoneStatId_Get.yaml +++ b/paths/SubsZoneStatId_Get.yaml @@ -1,10 +1,10 @@ +tags: +- subscriptions +operationId: zoneStatusGetById description: This operation is used for retrieving an individual subscription to zone status change notification. produces: - application/json -parameters: -- $ref: '#/parameters/Path.SubscriptionId' - responses: 200: description: Response to retrieve individual zone status subscription @@ -12,7 +12,6 @@ responses: properties: zoneStatusSubscription: $ref: '#/definitions/ZoneStatusSubscription' - examples: application/json: $ref: '../examples/ZoneStatusSubscription.json' \ No newline at end of file diff --git a/paths/SubsZoneStatId_Put.yaml b/paths/SubsZoneStatId_Put.yaml index 11883247ec702bd32788c25581aae0145de7d967..14d277bc1231d92c7c6b2119c8c46242a22fcd82 100644 --- a/paths/SubsZoneStatId_Put.yaml +++ b/paths/SubsZoneStatId_Put.yaml @@ -1,11 +1,12 @@ +tags: +- subscriptions +operationId: zoneStatusPutById description: This operation is used for updating an individual subscription to zone status change notification. produces: - application/json parameters: -- $ref: '#/parameters/Path.SubscriptionId' - $ref: '#/parameters/Body.ZoneStatusSubscription' - responses: 200: description: Response to update individual zone status subscription @@ -13,7 +14,6 @@ responses: properties: zoneStatusSubscription: $ref: '#/definitions/ZoneStatusSubscription' - examples: application/json: $ref: '../examples/ZoneStatusSubscription.json' \ No newline at end of file diff --git a/paths/SubsZoneStat_Get.yaml b/paths/SubsZoneStat_Get.yaml index 369111c6d4821b57d4fd660cc02c4b6cc6fad4c6..e246471bd2038721b4e67bbb3c97eb2d4940fb28 100644 --- a/paths/SubsZoneStat_Get.yaml +++ b/paths/SubsZoneStat_Get.yaml @@ -1,8 +1,10 @@ +tags: +- subscriptions +operationId: zoneStatusGet description: This operation is used for creating a new subscription to zone status change notification. produces: - application/json - responses: 200: description: Response to retrieve zone status subscriptions @@ -18,7 +20,6 @@ responses: $ref: '#/definitions/ZoneStatusSubscription' resourceURL: $ref: '#/definitions/ResourceURL' - examples: application/json: $ref: '../examples/NotiSubsListZoneStat.json' \ No newline at end of file diff --git a/paths/SubsZoneStat_Post.yaml b/paths/SubsZoneStat_Post.yaml index eccb63450fdf687bdbaae10ac1a4f7185220ccd1..67534c104b68fbc3d61a6c5b9afc9c2f1f3ab802 100644 --- a/paths/SubsZoneStat_Post.yaml +++ b/paths/SubsZoneStat_Post.yaml @@ -1,10 +1,12 @@ +tags: +- subscriptions +operationId: zoneStatusPost description: This operation is used for creating a new subscription to zone status change notification. produces: - application/json parameters: - $ref: '#/parameters/Body.ZoneStatusSubscription' - responses: 201: description: Response to create new zone status subscription @@ -12,7 +14,6 @@ responses: properties: zonalTrafficSubscription: $ref: '#/definitions/ZoneStatusSubscription' - examples: application/json: $ref: '../examples/ZoneStatusSubscription.json' \ No newline at end of file diff --git a/paths/UsersId.yaml b/paths/UsersId.yaml index 3e3c5816b0703bc4c83aef4dc14d19a41bfb3616..c55eee568a910c0df4cfb096c0c79156f6fb2862 100644 --- a/paths/UsersId.yaml +++ b/paths/UsersId.yaml @@ -1,2 +1,4 @@ +parameters: +- $ref: '#/parameters/Path.UserId' get: $ref: ./UsersId_Get.yaml \ No newline at end of file diff --git a/paths/UsersId_Get.yaml b/paths/UsersId_Get.yaml index f661b4a9f536476e2a80a241175b36964eb4b983..f988da256956a2a034f52a266bab8a7b7337ea20 100644 --- a/paths/UsersId_Get.yaml +++ b/paths/UsersId_Get.yaml @@ -1,10 +1,10 @@ +tags: +- users +operationId: usersGetById description: Users currently using a zone may be retrieved for sets of access points matching attribute in the request produces: - application/json -parameters: -- $ref: '#/parameters/Path.UserId' - responses: 200: description: Successful response to a query users within a zone request @@ -12,7 +12,6 @@ responses: properties: userInfo: $ref: '#/definitions/UserInfo' - examples: application/json: $ref: '../examples/UserInfo.json' \ No newline at end of file diff --git a/paths/Users_Get.yaml b/paths/Users_Get.yaml index 2d57527ab426c966d14cdd7ae49994dab585b716..b36c837ecbd155cdc1eeeb4c804018b26f328e61 100644 --- a/paths/Users_Get.yaml +++ b/paths/Users_Get.yaml @@ -1,3 +1,6 @@ +tags: +- users +operationId: usersGet description: Users currently using a zone may be retrieved for sets of access points matching attribute in the request produces: @@ -5,7 +8,6 @@ produces: parameters: - $ref: '#/parameters/Query.ZoneId' - $ref: '#/parameters/Query.AccessPointId' - responses: 200: description: Successful response to a query users within a zone request @@ -13,7 +15,6 @@ responses: properties: userList: $ref: '#/definitions/UserList' - examples: application/json: $ref: '../examples/UserList.json' \ No newline at end of file diff --git a/paths/ZonesId.yaml b/paths/ZonesId.yaml index b5b3ebce1e52e03d6a9ed8884ad14ffe23bf7cee..d8d3ebbf4d5af2eaa6b1cb3833487097bff473c0 100644 --- a/paths/ZonesId.yaml +++ b/paths/ZonesId.yaml @@ -1,2 +1,4 @@ +parameters: +- $ref: '#/parameters/Path.ZoneId' get: $ref: ./ZonesId_Get.yaml \ No newline at end of file diff --git a/paths/ZonesIdAps.yaml b/paths/ZonesIdAps.yaml index 37e8cefac1f0e272a43782f17e3b49ab8e606052..dd01b8d9fc39ef78cc3d01f1d9efa3a84955eda7 100644 --- a/paths/ZonesIdAps.yaml +++ b/paths/ZonesIdAps.yaml @@ -1,2 +1,4 @@ +parameters: +- $ref: '#/parameters/Path.ZoneId' get: $ref: ./ZonesIdAps_Get.yaml \ No newline at end of file diff --git a/paths/ZonesIdApsId.yaml b/paths/ZonesIdApsId.yaml index 29929040aea8ea1b4a3102b05c9f6bdf9732d1c6..5029debcdca1b3faa5037ba1f353c2bf1530781a 100644 --- a/paths/ZonesIdApsId.yaml +++ b/paths/ZonesIdApsId.yaml @@ -1,2 +1,5 @@ +parameters: +- $ref: '#/parameters/Path.ZoneId' +- $ref: '#/parameters/Path.AccessPointId' get: $ref: ./ZonesIdApsId_Get.yaml \ No newline at end of file diff --git a/paths/ZonesIdApsId_Get.yaml b/paths/ZonesIdApsId_Get.yaml index e592eb8f765b3f353d7f5ad1308a10f32c0eb2d7..05b3ddf85c35941fc1c3fb9029f72dacb9aff31f 100644 --- a/paths/ZonesIdApsId_Get.yaml +++ b/paths/ZonesIdApsId_Get.yaml @@ -1,11 +1,10 @@ +tags: +- zones +operationId: zonesByIdGetApsById description: Access point status can be retrieved for sets of access points matching attribute in the request. produces: - application/json -parameters: -- $ref: '#/parameters/Path.ZoneId' -- $ref: '#/parameters/Path.AccessPointId' - responses: 200: description: Successful response to a query a named set of access point status request @@ -13,7 +12,6 @@ responses: properties: accessPointInfo: $ref: '#/definitions/AccessPointInfo' - examples: application/json: $ref: '../examples/AccessPointInfo.json' \ No newline at end of file diff --git a/paths/ZonesIdAps_Get.yaml b/paths/ZonesIdAps_Get.yaml index a00ac7f4001525499cb199330a9bbf8e8b1feba5..2006d229e6fb1997b5b5ec7ef16e1f49a3b5decf 100644 --- a/paths/ZonesIdAps_Get.yaml +++ b/paths/ZonesIdAps_Get.yaml @@ -1,11 +1,12 @@ +tags: +- zones +operationId: zonesByIdGetAps description: Access point status can be retrieved for sets of access points matching attribute in the request. produces: - application/json parameters: -- $ref: '#/parameters/Path.ZoneId' - $ref: '#/parameters/Query.InterestRealm' - responses: 200: description: Successful response to a query a named set of access point status request @@ -13,7 +14,6 @@ responses: properties: accessPointList: $ref: '#/definitions/AccessPointList' - examples: application/json: $ref: '../examples/AccessPointList.json' \ No newline at end of file diff --git a/paths/ZonesId_Get.yaml b/paths/ZonesId_Get.yaml index ba5f74bd7406c94606dfe1204a42101b116aa040..e4f063ddda139ad236c84cbdd76e36bc9fb8a2ed 100644 --- a/paths/ZonesId_Get.yaml +++ b/paths/ZonesId_Get.yaml @@ -1,10 +1,10 @@ +tags: +- zones +operationId: zonesGetById description: Used to get the status of a zone. produces: - application/json -parameters: -- $ref: '#/parameters/Path.ZoneId' - responses: 200: description: Successful response to a query regarding the status of a zone @@ -12,7 +12,6 @@ responses: properties: zoneInfo: $ref: '#/definitions/ZoneInfo' - examples: application/json: $ref: '../examples/ZoneInfo.json' \ No newline at end of file diff --git a/paths/Zones_Get.yaml b/paths/Zones_Get.yaml index bc7abc42a855741250ca6e80413ef0b6f67f64a6..bd91d28353832a9d5b84dd93924696ce51f5e095 100644 --- a/paths/Zones_Get.yaml +++ b/paths/Zones_Get.yaml @@ -1,7 +1,9 @@ +tags: +- zones +operationId: zonesGet description: Used to get a list of identifiers for zones authorized for use by the application. produces: - application/json - responses: 200: description: Successful response to a query regarding the status of a zone @@ -9,7 +11,6 @@ responses: properties: zoneList: $ref: '#/definitions/ZoneList' - examples: application/json: $ref: '../examples/ZoneList.json' \ No newline at end of file diff --git a/tags/index.yaml b/tags/index.yaml new file mode 100644 index 0000000000000000000000000000000000000000..89f15a0a18a23eaf7c0a4d8f902c14ca225fa445 --- /dev/null +++ b/tags/index.yaml @@ -0,0 +1,3 @@ + - name: zones + - name: users + - name: subscriptions \ No newline at end of file