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

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
...@@ -3,18 +3,18 @@ ...@@ -3,18 +3,18 @@
"info": { "info": {
"title": "Location API", "title": "Location API",
"version": "1.1.1", "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": { "license": {
"name": "ETSI Forge copyright notice", "name": "ETSI Forge copyright notice",
"url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt" "url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
} }
}, },
"externalDocs": { "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" "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", "host": "127.0.0.1:8081",
"basePath": "/exampleAPI/location/v1/", "basePath": "/exampleAPI/location/v1",
"schemes": [ "schemes": [
"http", "http",
"https" "https"
...@@ -25,6 +25,17 @@ ...@@ -25,6 +25,17 @@
"produces": [ "produces": [
"application/json" "application/json"
], ],
"tags": [
{
"name": "zones"
},
{
"name": "users"
},
{
"name": "subscriptions"
}
],
"parameters": { "parameters": {
"Body.UserTrackingSubscription": { "Body.UserTrackingSubscription": {
"name": "userTrackingSubscription", "name": "userTrackingSubscription",
...@@ -106,6 +117,10 @@ ...@@ -106,6 +117,10 @@
"paths": { "paths": {
"/zones": { "/zones": {
"get": { "get": {
"tags": [
"zones"
],
"operationId": "zonesGet",
"description": "Used to get a list of identifiers for zones authorized for use by the application.", "description": "Used to get a list of identifiers for zones authorized for use by the application.",
"produces": [ "produces": [
"application/json" "application/json"
...@@ -148,16 +163,20 @@ ...@@ -148,16 +163,20 @@
} }
}, },
"/zones/{zoneId}": { "/zones/{zoneId}": {
"parameters": [
{
"$ref": "#/parameters/Path.ZoneId"
}
],
"get": { "get": {
"tags": [
"zones"
],
"operationId": "zonesGetById",
"description": "Used to get the status of a zone.", "description": "Used to get the status of a zone.",
"produces": [ "produces": [
"application/json" "application/json"
], ],
"parameters": [
{
"$ref": "#/parameters/Path.ZoneId"
}
],
"responses": { "responses": {
"200": { "200": {
"description": "Successful response to a query regarding the status of a zone", "description": "Successful response to a query regarding the status of a zone",
...@@ -184,15 +203,21 @@ ...@@ -184,15 +203,21 @@
} }
}, },
"/zones/{zoneId}/accessPoints": { "/zones/{zoneId}/accessPoints": {
"parameters": [
{
"$ref": "#/parameters/Path.ZoneId"
}
],
"get": { "get": {
"tags": [
"zones"
],
"operationId": "zonesByIdGetAps",
"description": "Access point status can be retrieved for sets of access points matching attribute in the request.", "description": "Access point status can be retrieved for sets of access points matching attribute in the request.",
"produces": [ "produces": [
"application/json" "application/json"
], ],
"parameters": [ "parameters": [
{
"$ref": "#/parameters/Path.ZoneId"
},
{ {
"$ref": "#/parameters/Query.InterestRealm" "$ref": "#/parameters/Query.InterestRealm"
} }
...@@ -264,19 +289,23 @@ ...@@ -264,19 +289,23 @@
} }
}, },
"/zones/{zoneId}/accessPoints/{accessPointId}": { "/zones/{zoneId}/accessPoints/{accessPointId}": {
"parameters": [
{
"$ref": "#/parameters/Path.ZoneId"
},
{
"$ref": "#/parameters/Path.AccessPointId"
}
],
"get": { "get": {
"tags": [
"zones"
],
"operationId": "zonesByIdGetApsById",
"description": "Access point status can be retrieved for sets of access points matching attribute in the request.", "description": "Access point status can be retrieved for sets of access points matching attribute in the request.",
"produces": [ "produces": [
"application/json" "application/json"
], ],
"parameters": [
{
"$ref": "#/parameters/Path.ZoneId"
},
{
"$ref": "#/parameters/Path.AccessPointId"
}
],
"responses": { "responses": {
"200": { "200": {
"description": "Successful response to a query a named set of access point status request", "description": "Successful response to a query a named set of access point status request",
...@@ -311,6 +340,10 @@ ...@@ -311,6 +340,10 @@
}, },
"/users": { "/users": {
"get": { "get": {
"tags": [
"users"
],
"operationId": "usersGet",
"description": "Users currently using a zone may be retrieved for sets of access points matching attribute in the request", "description": "Users currently using a zone may be retrieved for sets of access points matching attribute in the request",
"produces": [ "produces": [
"application/json" "application/json"
...@@ -377,16 +410,20 @@ ...@@ -377,16 +410,20 @@
} }
}, },
"/users/{userId}": { "/users/{userId}": {
"parameters": [
{
"$ref": "#/parameters/Path.UserId"
}
],
"get": { "get": {
"tags": [
"users"
],
"operationId": "usersGetById",
"description": "Users currently using a zone may be retrieved for sets of access points matching attribute in the request", "description": "Users currently using a zone may be retrieved for sets of access points matching attribute in the request",
"produces": [ "produces": [
"application/json" "application/json"
], ],
"parameters": [
{
"$ref": "#/parameters/Path.UserId"
}
],
"responses": { "responses": {
"200": { "200": {
"description": "Successful response to a query users within a zone request", "description": "Successful response to a query users within a zone request",
...@@ -420,6 +457,10 @@ ...@@ -420,6 +457,10 @@
}, },
"/subscriptions/zonalTraffic": { "/subscriptions/zonalTraffic": {
"get": { "get": {
"tags": [
"subscriptions"
],
"operationId": "zonalTrafficSubGet",
"description": "This operation is used for retrieving all active subscriptions to zonal traffic change notifications.", "description": "This operation is used for retrieving all active subscriptions to zonal traffic change notifications.",
"produces": [ "produces": [
"application/json" "application/json"
...@@ -479,6 +520,10 @@ ...@@ -479,6 +520,10 @@
} }
}, },
"post": { "post": {
"tags": [
"subscriptions"
],
"operationId": "zonalTrafficSubPost",
"description": "This operation is used for creating a new subscription to zonal traffic change notification.", "description": "This operation is used for creating a new subscription to zonal traffic change notification.",
"produces": [ "produces": [
"application/json" "application/json"
...@@ -517,16 +562,20 @@ ...@@ -517,16 +562,20 @@
} }
}, },
"/subscriptions/zonalTraffic/{subscriptionId}": { "/subscriptions/zonalTraffic/{subscriptionId}": {
"parameters": [
{
"$ref": "#/parameters/Path.SubscriptionId"
}
],
"get": { "get": {
"tags": [
"subscriptions"
],
"operationId": "zonalTrafficSubGetById",
"description": "This operation is used for updating an individual subscription to zonal traffic change notification.", "description": "This operation is used for updating an individual subscription to zonal traffic change notification.",
"produces": [ "produces": [
"application/json" "application/json"
], ],
"parameters": [
{
"$ref": "#/parameters/Path.SubscriptionId"
}
],
"responses": { "responses": {
"200": { "200": {
"description": "Response to retrieve individual zonal traffic subscription", "description": "Response to retrieve individual zonal traffic subscription",
...@@ -555,14 +604,15 @@ ...@@ -555,14 +604,15 @@
} }
}, },
"put": { "put": {
"tags": [
"subscriptions"
],
"operationId": "zonalTrafficSubPutById",
"description": "This operation is used for updating an individual subscription to zonal traffic change notification.", "description": "This operation is used for updating an individual subscription to zonal traffic change notification.",
"produces": [ "produces": [
"application/json" "application/json"
], ],
"parameters": [ "parameters": [
{
"$ref": "#/parameters/Path.SubscriptionId"
},
{ {
"$ref": "#/parameters/Body.ZonalTrafficSubscription" "$ref": "#/parameters/Body.ZonalTrafficSubscription"
} }
...@@ -595,15 +645,14 @@ ...@@ -595,15 +645,14 @@
} }
}, },
"delete": { "delete": {
"tags": [
"subscriptions"
],
"operationId": "zonalTrafficSubDelById",
"description": "This operation is used for cancelling a subscription and stopping corresponding notifications.", "description": "This operation is used for cancelling a subscription and stopping corresponding notifications.",
"produces": [ "produces": [
"application/json" "application/json"
], ],
"parameters": [
{
"$ref": "#/parameters/Path.SubscriptionId"
}
],
"responses": { "responses": {
"204": { "204": {
"description": "No content" "description": "No content"
...@@ -613,6 +662,10 @@ ...@@ -613,6 +662,10 @@
}, },
"/subscriptions/userTracking": { "/subscriptions/userTracking": {
"get": { "get": {
"tags": [
"subscriptions"
],
"operationId": "userTrackingSubGet",
"description": "This operation is used for retrieving all active subscriptions to user tracking change notifications.", "description": "This operation is used for retrieving all active subscriptions to user tracking change notifications.",
"produces": [ "produces": [
"application/json" "application/json"
...@@ -670,6 +723,10 @@ ...@@ -670,6 +723,10 @@
} }
}, },
"post": { "post": {
"tags": [
"subscriptions"
],
"operationId": "userTrackingSubPost",
"description": "This operation is used for creating a new subscription to user tracking change notification", "description": "This operation is used for creating a new subscription to user tracking change notification",
"produces": [ "produces": [
"application/json" "application/json"
...@@ -707,16 +764,20 @@ ...@@ -707,16 +764,20 @@
} }
}, },
"/subscriptions/userTracking/{subscriptionId}": { "/subscriptions/userTracking/{subscriptionId}": {
"parameters": [
{
"$ref": "#/parameters/Path.SubscriptionId"
}
],
"get": { "get": {
"tags": [
"subscriptions"
],
"operationId": "userTrackingSubGetById",
"description": "This operation is used for retrieving an individual subscription to user tracking change notification.", "description": "This operation is used for retrieving an individual subscription to user tracking change notification.",
"produces": [ "produces": [
"application/json" "application/json"
], ],
"parameters": [
{
"$ref": "#/parameters/Path.SubscriptionId"
}
],
"responses": { "responses": {
"200": { "200": {
"description": "Response to retrieve individual user tracking subscription", "description": "Response to retrieve individual user tracking subscription",
...@@ -744,14 +805,15 @@ ...@@ -744,14 +805,15 @@
} }
}, },
"put": { "put": {
"tags": [
"subscriptions"
],
"operationId": "userTrackingSubPutById",
"description": "This operation is used for updating an individual subscription to user tracking change notification.", "description": "This operation is used for updating an individual subscription to user tracking change notification.",
"produces": [ "produces": [
"application/json" "application/json"
], ],
"parameters": [ "parameters": [
{
"$ref": "#/parameters/Path.SubscriptionId"
},
{ {
"$ref": "#/parameters/Body.UserTrackingSubscription" "$ref": "#/parameters/Body.UserTrackingSubscription"
} }
...@@ -783,15 +845,14 @@ ...@@ -783,15 +845,14 @@
} }
}, },
"delete": { "delete": {
"tags": [
"subscriptions"
],
"operationId": "userTrackingSubDelById",
"description": "This operation is used for retrieving an individual subscription to user tracking change notification.", "description": "This operation is used for retrieving an individual subscription to user tracking change notification.",
"produces": [ "produces": [
"application/json" "application/json"
], ],
"parameters": [
{
"$ref": "#/parameters/Path.SubscriptionId"
}
],
"responses": { "responses": {
"204": { "204": {
"description": "No Content" "description": "No Content"
...@@ -801,6 +862,10 @@ ...@@ -801,6 +862,10 @@
}, },
"/subscriptions/zonalStatus": { "/subscriptions/zonalStatus": {
"get": { "get": {
"tags": [
"subscriptions"
],
"operationId": "zoneStatusGet",
"description": "This operation is used for creating a new subscription to zone status change notification.", "description": "This operation is used for creating a new subscription to zone status change notification.",
"produces": [ "produces": [
"application/json" "application/json"
...@@ -860,6 +925,10 @@ ...@@ -860,6 +925,10 @@
} }
}, },
"post": { "post": {
"tags": [
"subscriptions"
],
"operationId": "zoneStatusPost",
"description": "This operation is used for creating a new subscription to zone status change notification.", "description": "This operation is used for creating a new subscription to zone status change notification.",
"produces": [ "produces": [
"application/json" "application/json"
...@@ -898,16 +967,20 @@ ...@@ -898,16 +967,20 @@
} }
}, },
"/subscriptions/zoneStatus/{subscriptionId}": { "/subscriptions/zoneStatus/{subscriptionId}": {
"parameters": [
{
"$ref": "#/parameters/Path.SubscriptionId"
}
],
"get": { "get": {
"tags": [
"subscriptions"
],
"operationId": "zoneStatusGetById",
"description": "This operation is used for retrieving an individual subscription to zone status change notification.", "description": "This operation is used for retrieving an individual subscription to zone status change notification.",
"produces": [ "produces": [
"application/json" "application/json"
], ],
"parameters": [
{
"$ref": "#/parameters/Path.SubscriptionId"
}
],
"responses": { "responses": {
"200": { "200": {
"description": "Response to retrieve individual zone status subscription", "description": "Response to retrieve individual zone status subscription",
...@@ -936,14 +1009,15 @@ ...@@ -936,14 +1009,15 @@
} }
}, },
"put": { "put": {
"tags": [
"subscriptions"
],
"operationId": "zoneStatusPutById",
"description": "This operation is used for updating an individual subscription to zone status change notification.", "description": "This operation is used for updating an individual subscription to zone status change notification.",
"produces": [ "produces": [
"application/json" "application/json"
], ],
"parameters": [ "parameters": [
{
"$ref": "#/parameters/Path.SubscriptionId"
},
{ {
"$ref": "#/parameters/Body.ZoneStatusSubscription" "$ref": "#/parameters/Body.ZoneStatusSubscription"
} }
...@@ -976,15 +1050,14 @@ ...@@ -976,15 +1050,14 @@
} }
}, },
"delete": { "delete": {
"tags": [
"subscriptions"
],
"operationId": "zoneStatusDelById",
"description": "This operation is used for cancelling a subscription and stopping corresponding notifications.", "description": "This operation is used for cancelling a subscription and stopping corresponding notifications.",
"produces": [ "produces": [
"application/json" "application/json"
], ],
"parameters": [
{
"$ref": "#/parameters/Path.SubscriptionId"
}
],
"responses": { "responses": {
"204": { "204": {
"description": "No content" "description": "No content"
......
...@@ -16,7 +16,7 @@ externalDocs: ...@@ -16,7 +16,7 @@ externalDocs:
$ref: './externalDocs/index.yaml' $ref: './externalDocs/index.yaml'
host: 127.0.0.1:8081 host: 127.0.0.1:8081
basePath: /exampleAPI/location/v1/ basePath: /exampleAPI/location/v1
schemes: schemes:
- http - http
- https - https
...@@ -25,6 +25,12 @@ consumes: ...@@ -25,6 +25,12 @@ consumes:
produces: produces:
- application/json - application/json
################################################################################
# Tags #
################################################################################
tags:
$ref: './tags/index.yaml'
################################################################################ ################################################################################
# Parameters # # Parameters #
################################################################################ ################################################################################
......
<