Commit 5baec46e by Walter Featherstone

Editorials in the description and updated split files

Change-Id: Ie4fbdb6cfa1ffe977f0ddfb317e55b6c9dc2bb83 Signed-off-by: Walter Featherstone's avatarfeatherstone <walter.featherstone@viavisolutions.com>
parent c4d95e7a
################################################################################
# Open API specification version #
################################################################################
swagger: '2.0'
################################################################################
# Document Information #
################################################################################
info:
$ref: './info/index.yaml'
################################################################################
# External Documents #
################################################################################
externalDocs:
$ref: './externalDocs/index.yaml'
host: 127.0.0.1:8081
basePath: /exampleAPI/location/v1/
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
################################################################################
# Parameters #
################################################################################
parameters:
$ref: './parameters/index.yaml'
################################################################################
# paths #
################################################################################
paths:
$ref: './paths/index.yaml'
################################################################################
# Definitions #
################################################################################
definitions:
$ref: './definitions/index.yaml'
################################################################################
# SEEMINGLY NOT ALLOWED in Swagger/OpenAPI 2.0 #
# #
# Examples #
################################################################################
#examples:
# $ref: './examples/index.yaml'
\ No newline at end of file
description: >-
Identifier of access point, <E-CGI><Cell Portion ID> (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
description: Identifier of access point, <E-CGI><Cell Portion ID> (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"
\ No newline at end of file
description: A type containing access point information.
type: object
required:
- accessPointId
- connectionType
......
description: A type containing list of access points.
type: object
required:
- zoneId
- resourceURL
......
required:
- address
properties:
address:
$ref: '#/definitions/Address'
\ No newline at end of file
description: Reserved for future use.
type: string
\ No newline at end of file
description: Notification callback definition.
type: object
required:
- notifyURL
properties:
......
description: Contextual information of a user location (e.g., aisle, floor, room number, etc.)
type: string
example: "GroundFoor"
\ No newline at end of file
example: "GroundFloor"
\ No newline at end of file
description: Link to other resources
type: object
required:
- rel
- href
......
description: A type containing user information.
type: object
required:
- address
- accessPointId
......
description: A type containing list of users.
type: object
required:
- resourceURL
properties:
......
description: A type containing user tracking subscription.
type: object
required:
- callbackReference
- address
......
description: A type containing zonal presence notification
type: object
required:
- zoneId
- address
......
......@@ -16,7 +16,6 @@ properties:
items:
$ref: '#/definitions/InterestRealm'
userEventCriteria:
# $ref: '#/definitions/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:
......
description: A type containing zone information.
type: object
required:
- zoneId
- numberOfAccessPoints
......
description: Collection of the zone information list.
type: object
required:
- resourceURL
properties:
......
description: A type containing zone status notification.
type: object
required:
- zoneId
- timestamp
......
description: A type containing zone status subscription.
type: object
required:
- callbackReference
- zoneId
......
AccessPointId:
$ref: ./AccessPointId.yaml
AccessPointInfo:
$ref: ./AccessPointInfo.yaml
AccessPointList:
$ref: ./AccessPointList.yaml
Address:
$ref: ./Address.yaml
AncillaryInfo:
$ref: ./AncillaryInfo.yaml
CallbackData:
$ref: ./CallbackData.yaml
CallbackReference:
$ref: ./CallbackReference.yaml
ClientCorrelator:
$ref: ./ClientCorrelator.yaml
ConnectionType:
$ref: ./ConnectionType.yaml
ContextLocationInfo:
$ref: ./ContextLocationInfo.yaml
CurrentAccessPointId:
$ref: ./CurrentAccessPointId.yaml
Duration:
$ref: ./Duration.yaml
InterestRealm:
$ref: ./InterestRealm.yaml
Link:
$ref: ./Link.yaml
LocationInfo:
$ref: ./LocationInfo.yaml
NotifyURL:
$ref: ./NotifyURL.yaml
NumberOfAccessPoints:
$ref: ./NumberOfAccessPoints.yaml
NumberOfUnserviceableAccessPoints:
$ref: ./NumberOfUnserviceableAccessPoints.yaml
NumberOfUsers:
$ref: ./NumberOfUsers.yaml
NumberOfUsersAPThreshold:
$ref: ./NumberOfUsersAPThreshold.yaml
NumberOfUsersInAP:
$ref: ./NumberOfUsersInAP.yaml
NumberOfUsersInZone:
$ref: ./NumberOfUsersInZone.yaml
NumberOfUsersZoneThreshold:
$ref: ./NumberOfUsersZoneThreshold.yaml
OperationStatus:
$ref: ./OperationStatus.yaml
PreviousAccessPointId:
$ref: ./PreviousAccessPointId.yaml
ResourceURL:
$ref: ./ResourceURL.yaml
Timestamp:
$ref: ./Timestamp.yaml
Timezone:
$ref: ./Timezone.yaml
UserEventCriteria:
$ref: ./UserEventCriteria.yaml
UserEventType:
$ref: ./UserEventType.yaml
UserInfo:
$ref: ./UserInfo.yaml
UserList:
$ref: ./UserList.yaml
UserTrackingSubscription:
$ref: ./UserTrackingSubscription.yaml
ZonalPresenceNotification:
$ref: ./ZonalPresenceNotification.yaml
ZonalTrafficSubscription:
$ref: ./ZonalTrafficSubscription.yaml
ZoneId:
$ref: ./ZoneId.yaml
ZoneInfo:
$ref: ./ZoneInfo.yaml
ZoneList:
$ref: ./ZoneList.yaml
ZoneStatusNotification:
$ref: ./ZoneStatusNotification.yaml
ZoneStatusSubscription:
$ref: ./ZoneStatusSubscription.yaml
\ No newline at end of file
description: "ETSI MEC013 V1.0.1 Location Service API"
url: "https://docbox.etsi.org/ISG/MEC/70-Draft/0013LocationApi"
\ No newline at end of file
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'
\ No newline at end of file
description: "The MEC-013 Location API described using OpenAPI, which is based on the Open Mobile Alliance's specification RESTful Network API for Zonal Presence"
version: '1.0.1'
title: 'MEC Location API'
license:
name: ETSI Forge copyright notice
url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
\ No newline at end of file
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'
\ No newline at end of file
name: userTrackingSubscription
in: body
description: User Tracking Subscription
required: true
schema:
$ref: '#/definitions/UserTrackingSubscription'
\ No newline at end of file
name: zonalTrafficSubscription
in: body
description: Zonal Traffic Subscription
required: true
schema:
$ref: '#/definitions/ZonalTrafficSubscription'
\ No newline at end of file
name: zoneStatusSubscription
in: body
description: Zone Status Subscription
required: true
schema:
$ref: '#/definitions/ZoneStatusSubscription'
\ No newline at end of file
name: accessPointId
in: path
description: Access Point ID
required: true
type: string
\ No newline at end of file
name: subscriptionId
in: path
description: Subscription ID
required: true
type: string
\ No newline at end of file
name: userId
in: path
description: User ID
required: true
type: string
\ No newline at end of file
name: zoneId
in: path
description: Zone ID
required: true
type: string
\ No newline at end of file
ZoneId:
$ref: ./ZoneId.yaml
AccessPointId:
$ref: ./AccessPointId.yaml
InterestRealm:
$ref: ./InterestRealm.yaml
\ No newline at end of file
Body.UserTrackingSubscription:
$ref: ./Body.UserTrackingSubscription.yaml
Body.ZonalTrafficSubscription:
$ref: ./Body.ZonalTrafficSubscription.yaml
Body.ZoneStatusSubscription:
$ref: ./Body.ZoneStatusSubscription.yaml
Path.AccessPointId:
$ref: ./Path.AccessPointId.yaml
Path.SubscriptionId:
$ref: ./Path.SubscriptionId.yaml
Path.UserId:
$ref: ./Path.UserId.yaml
Path.ZoneId:
$ref: ./Path.ZoneId.yaml
Query.AccessPointId:
$ref: ./Query.AccessPointId.yaml
Query.InterestRealm:
$ref: ./Query.InterestRealm.yaml
Query.ZoneId:
$ref: ./Query.ZoneId.yaml
......@@ -3,11 +3,7 @@ description:
produces:
- application/json
parameters:
- name: subscriptionId
in: path
description: Subscription ID
required: true
type: string
- $ref: '#/parameters/Path.SubscriptionId'
responses:
204:
......
......@@ -3,11 +3,7 @@ description:
produces:
- application/json
parameters:
- name: subscriptionId
in: path
description: Subscription ID
required: true
type: string
- $ref: '#/parameters/Path.SubscriptionId'
responses:
200:
......
......@@ -3,17 +3,8 @@ description:
produces:
- application/json
parameters:
- name: subscriptionId
in: path
description: Subscription ID
required: true
type: string
- name: userTrackingSubscription
in: body
description: User Tracking Subscription
required: true
schema:
$ref: '#/definitions/UserTrackingSubscription'
- $ref: '#/parameters/Path.SubscriptionId'
- $ref: '#/parameters/Body.UserTrackingSubscription'
responses:
200:
......
......@@ -3,12 +3,7 @@ description:
produces:
- application/json
parameters:
- name: userTrackingSubscription
in: body
description: User Tracking Subscription
required: true
schema:
$ref: '#/definitions/UserTrackingSubscription'
- $ref: '#/parameters/Body.UserTrackingSubscription'
responses:
201:
......
......@@ -3,11 +3,7 @@ description:
produces:
- application/json
parameters:
- name: subscriptionId
in: path
description: Subscription ID
required: true
type: string
- $ref: '#/parameters/Path.SubscriptionId'
responses:
204:
......
......@@ -3,11 +3,7 @@ description:
produces:
- application/json
parameters:
- name: subscriptionId
in: path
description: Subscription ID
required: true
type: string
- $ref: '#/parameters/Path.SubscriptionId'
responses:
200:
......
......@@ -3,17 +3,8 @@ description:
produces:
- application/json
parameters:
- name: subscriptionId
in: path
description: Subscription ID
required: true
type: string
- name: zonalTrafficSubscription
in: body
description: Zonal Traffic Subscription
required: true
schema:
$ref: '#/definitions/ZonalTrafficSubscription'
- $ref: '#/parameters/Path.SubscriptionId'
- $ref: '#/parameters/Body.ZonalTrafficSubscription'
responses:
200:
......
......@@ -3,12 +3,7 @@ description:
produces:
- application/json
parameters:
- name: zonalTrafficSubscription
in: body
description: Zonal Traffic Subscription
required: true
schema:
$ref: '#/definitions/ZonalTrafficSubscription'
- $ref: '#/parameters/Body.ZonalTrafficSubscription'
responses:
201:
......
......@@ -2,4 +2,7 @@ get:
$ref: ./SubsZoneStatId_Get.yaml
put:
$ref: ./SubsZoneStatId_Put.yaml
\ No newline at end of file
$ref: ./SubsZoneStatId_Put.yaml
delete:
$ref: ./SubsZoneStatId_Del.yaml
\ No newline at end of file
......@@ -3,11 +3,7 @@ description:
produces:
- application/json
parameters:
- name: subscriptionId
in: path
description: Subscription ID
required: true
type: string
- $ref: '#/parameters/Path.SubscriptionId'
responses:
204:
......
......@@ -3,11 +3,7 @@ description:
produces:
- application/json
parameters:
- name: subscriptionId
in: path
description: Subscription ID
required: true
type: string
- $ref: '#/parameters/Path.SubscriptionId'
responses:
200:
......
......@@ -3,17 +3,8 @@ description:
produces:
- application/json
parameters:
- name: subscriptionId
in: path
description: Subscription ID
required: true
type: string
- name: zoneStatusSubscription
in: body
description: Zone Status Subscription
required: true
schema:
$ref: '#/definitions/ZoneStatusSubscription'
- $ref: '#/parameters/Path.SubscriptionId'
- $ref: '#/parameters/Body.ZoneStatusSubscription'
responses:
200:
......
......@@ -3,13 +3,7 @@ description:
produces:
- application/json
parameters:
- name: zoneStatusSubscription
in: body
description: Zone Status Subscription
required: true
schema:
$ref: '#/definitions/ZoneStatusSubscription'
- $ref: '#/parameters/Body.ZoneStatusSubscription'
responses:
201:
......
......@@ -3,11 +3,7 @@ description:
produces:
- application/json
parameters:
- name: userId
in: path
description: User ID
required: true
type: string
- $ref: '#/parameters/Path.UserId'
responses:
200:
......
......@@ -3,8 +3,8 @@ description:
produces:
- application/json
parameters:
- $ref: '#/parameters/ZoneId'
- $ref: '#/parameters/AccessPointId'
- $ref: '#/parameters/Query.ZoneId'
- $ref: '#/parameters/Query.AccessPointId'
responses:
200:
......
......@@ -3,16 +3,8 @@ description:
produces:
- application/json
parameters:
- name: zoneId
in: path
description: Zone ID
required: true
type: string
- name: accessPointId
in: path
description: Access Point ID
required: true
type: string
- $ref: '#/parameters/Path.ZoneId'
- $ref: '#/parameters/Path.AccessPointId'
responses:
200:
......
......@@ -3,12 +3,8 @@ description:
produces:
- application/json
parameters:
- name: zoneId
in: path
description: Zone ID
required: true
type: string
- $ref: '#/parameters/InterestRealm'
- $ref: '#/parameters/Path.ZoneId'
- $ref: '#/parameters/Query.InterestRealm'
responses:
200:
......
......@@ -3,11 +3,7 @@ description:
produces:
- application/json
parameters:
- name: zoneId
in: path
description: Zone ID
required: true
type: string
- $ref: '#/parameters/Path.ZoneId'
responses:
200:
......
......@@ -12,53 +12,4 @@ responses:
examples:
application/json:
$ref: '../examples/ZoneList.json'
# works, but what does it add?!
# application/json:
# $ref: '../examples/index.yaml#/ZonesGetResponse'
# works
# application/json:
# $ref: '../examples/ZonesGetResponse.json'
# works
# 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"
# }
# }
# works
# 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
\ No newline at end of file
$ref: '../examples/ZoneList.json'
\ 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