Commit 378ceeba authored by Walter Featherstone's avatar Walter Featherstone

Removed extra '/' from basePath. To each procedure, added tags and operationId

Change-Id: Ieaaaed75a5e25f2a19bd28f9bdca5ed4338bea5f
Signed-off-by: Walter Featherstone's avatarfeatherstone <walter.featherstone@viavisolutions.com>
parent b608c022
This diff is collapsed.
......@@ -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 #
################################################################################
......
This diff is collapsed.
parameters:
- $ref: '#/parameters/Path.SubscriptionId'
get:
$ref: ./SubsUserTrackId_Get.yaml
......
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
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
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
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
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'
parameters:
- $ref: '#/parameters/Path.SubscriptionId'
get:
$ref: ./SubsZonalTrafId_Get.yaml
......
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
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
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
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
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
parameters:
- $ref: '#/parameters/Path.SubscriptionId'
get:
$ref: ./SubsZoneStatId_Get.yaml
......
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
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
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
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
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
parameters:
- $ref: '#/parameters/Path.UserId'
get:
$ref: ./UsersId_Get.yaml
\ No newline at end of file
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
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
parameters:
- $ref: '#/parameters/Path.ZoneId'
get:
$ref: ./ZonesId_Get.yaml
\ No newline at end of file
parameters:
- $ref: '#/parameters/Path.ZoneId'
get:
$ref: ./ZonesIdAps_Get.yaml
\ No newline at end of file
parameters:
- $ref: '#/parameters/Path.ZoneId'
- $ref: '#/parameters/Path.AccessPointId'
get:
$ref: ./ZonesIdApsId_Get.yaml
\ No newline at end of file
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
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
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
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
- name: zones
- name: users
- name: subscriptions
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment