From 5baec46e04086b8dd35009a78d268dfcb4a9be51 Mon Sep 17 00:00:00 2001 From: featherstone Date: Thu, 13 Jul 2017 11:22:14 +0100 Subject: [PATCH] Editorials in the description and updated split files Change-Id: Ie4fbdb6cfa1ffe977f0ddfb317e55b6c9dc2bb83 Signed-off-by: featherstone --- LocationAPI.index.yaml | 52 ------------------- definitions/AccessPointId.yaml | 3 +- definitions/AccessPointInfo.yaml | 2 + definitions/AccessPointList.yaml | 2 + definitions/AncillaryInfo.yaml | 7 +-- definitions/CallbackReference.yaml | 2 + definitions/ContextLocationInfo.yaml | 2 +- definitions/Link.yaml | 2 + definitions/UserInfo.yaml | 2 + definitions/UserList.yaml | 1 + definitions/UserTrackingSubscription.yaml | 2 + definitions/ZonalPresenceNotification.yaml | 2 + definitions/ZonalTrafficSubscription.yaml | 1 - definitions/ZoneInfo.yaml | 1 + definitions/ZoneList.yaml | 1 + definitions/ZoneStatusNotification.yaml | 2 + definitions/ZoneStatusSubscription.yaml | 2 + definitions/index.yaml | 39 -------------- externalDocs/index.yaml | 4 +- info/index.yaml | 12 ++--- parameters/Body.UserTrackingSubscription.yaml | 6 +++ parameters/Body.ZonalTrafficSubscription.yaml | 6 +++ parameters/Body.ZoneStatusSubscription.yaml | 6 +++ parameters/Path.AccessPointId.yaml | 5 ++ parameters/Path.SubscriptionId.yaml | 5 ++ parameters/Path.UserId.yaml | 5 ++ parameters/Path.ZoneId.yaml | 5 ++ ...sPointId.yaml => Query.AccessPointId.yaml} | 0 ...estRealm.yaml => Query.InterestRealm.yaml} | 0 parameters/{ZoneId.yaml => Query.ZoneId.yaml} | 0 parameters/index.yaml | 26 +++++++--- paths/SubsUserTrackId_Del.yaml | 6 +-- paths/SubsUserTrackId_Get.yaml | 6 +-- paths/SubsUserTrackId_Put.yaml | 13 +---- paths/SubsUserTrack_Post.yaml | 7 +-- paths/SubsZonalTrafId_Del.yaml | 6 +-- paths/SubsZonalTrafId_Get.yaml | 6 +-- paths/SubsZonalTrafId_Put.yaml | 13 +---- paths/SubsZonalTraf_Post.yaml | 7 +-- paths/SubsZoneStatId.yaml | 5 +- paths/SubsZoneStatId_Del.yaml | 6 +-- paths/SubsZoneStatId_Get.yaml | 6 +-- paths/SubsZoneStatId_Put.yaml | 13 +---- paths/SubsZoneStat_Post.yaml | 8 +-- paths/UsersId_Get.yaml | 6 +-- paths/Users_Get.yaml | 4 +- paths/ZonesIdApsId_Get.yaml | 12 +---- paths/ZonesIdAps_Get.yaml | 8 +-- paths/ZonesId_Get.yaml | 6 +-- paths/Zones_Get.yaml | 51 +----------------- 50 files changed, 119 insertions(+), 275 deletions(-) delete mode 100644 LocationAPI.index.yaml create mode 100644 parameters/Body.UserTrackingSubscription.yaml create mode 100644 parameters/Body.ZonalTrafficSubscription.yaml create mode 100644 parameters/Body.ZoneStatusSubscription.yaml create mode 100644 parameters/Path.AccessPointId.yaml create mode 100644 parameters/Path.SubscriptionId.yaml create mode 100644 parameters/Path.UserId.yaml create mode 100644 parameters/Path.ZoneId.yaml rename parameters/{AccessPointId.yaml => Query.AccessPointId.yaml} (100%) rename parameters/{InterestRealm.yaml => Query.InterestRealm.yaml} (100%) rename parameters/{ZoneId.yaml => Query.ZoneId.yaml} (100%) diff --git a/LocationAPI.index.yaml b/LocationAPI.index.yaml deleted file mode 100644 index 8fc1e88..0000000 --- a/LocationAPI.index.yaml +++ /dev/null @@ -1,52 +0,0 @@ -################################################################################ -# 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 diff --git a/definitions/AccessPointId.yaml b/definitions/AccessPointId.yaml index 6c4cf1b..f905377 100644 --- a/definitions/AccessPointId.yaml +++ b/definitions/AccessPointId.yaml @@ -1,4 +1,3 @@ -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 +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" \ No newline at end of file diff --git a/definitions/AccessPointInfo.yaml b/definitions/AccessPointInfo.yaml index 7dfc453..9a4c4f9 100644 --- a/definitions/AccessPointInfo.yaml +++ b/definitions/AccessPointInfo.yaml @@ -1,3 +1,5 @@ +description: A type containing access point information. +type: object required: - accessPointId - connectionType diff --git a/definitions/AccessPointList.yaml b/definitions/AccessPointList.yaml index e324425..d864e17 100644 --- a/definitions/AccessPointList.yaml +++ b/definitions/AccessPointList.yaml @@ -1,3 +1,5 @@ +description: A type containing list of access points. +type: object required: - zoneId - resourceURL diff --git a/definitions/AncillaryInfo.yaml b/definitions/AncillaryInfo.yaml index 90cf1f0..686294c 100644 --- a/definitions/AncillaryInfo.yaml +++ b/definitions/AncillaryInfo.yaml @@ -1,5 +1,2 @@ -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 diff --git a/definitions/CallbackReference.yaml b/definitions/CallbackReference.yaml index fb5a1e8..305a899 100644 --- a/definitions/CallbackReference.yaml +++ b/definitions/CallbackReference.yaml @@ -1,3 +1,5 @@ +description: Notification callback definition. +type: object required: - notifyURL properties: diff --git a/definitions/ContextLocationInfo.yaml b/definitions/ContextLocationInfo.yaml index 5326e7d..569a725 100644 --- a/definitions/ContextLocationInfo.yaml +++ b/definitions/ContextLocationInfo.yaml @@ -1,3 +1,3 @@ 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 diff --git a/definitions/Link.yaml b/definitions/Link.yaml index 163887f..bc8680e 100644 --- a/definitions/Link.yaml +++ b/definitions/Link.yaml @@ -1,3 +1,5 @@ +description: Link to other resources +type: object required: - rel - href diff --git a/definitions/UserInfo.yaml b/definitions/UserInfo.yaml index 5f2bf93..160bca1 100644 --- a/definitions/UserInfo.yaml +++ b/definitions/UserInfo.yaml @@ -1,3 +1,5 @@ +description: A type containing user information. +type: object required: - address - accessPointId diff --git a/definitions/UserList.yaml b/definitions/UserList.yaml index bfdd096..9de3640 100644 --- a/definitions/UserList.yaml +++ b/definitions/UserList.yaml @@ -1,4 +1,5 @@ description: A type containing list of users. +type: object required: - resourceURL properties: diff --git a/definitions/UserTrackingSubscription.yaml b/definitions/UserTrackingSubscription.yaml index 4253016..eeabe11 100644 --- a/definitions/UserTrackingSubscription.yaml +++ b/definitions/UserTrackingSubscription.yaml @@ -1,3 +1,5 @@ +description: A type containing user tracking subscription. +type: object required: - callbackReference - address diff --git a/definitions/ZonalPresenceNotification.yaml b/definitions/ZonalPresenceNotification.yaml index 3359e3d..2e1bb68 100644 --- a/definitions/ZonalPresenceNotification.yaml +++ b/definitions/ZonalPresenceNotification.yaml @@ -1,3 +1,5 @@ +description: A type containing zonal presence notification +type: object required: - zoneId - address diff --git a/definitions/ZonalTrafficSubscription.yaml b/definitions/ZonalTrafficSubscription.yaml index 0ab3cfe..d101919 100644 --- a/definitions/ZonalTrafficSubscription.yaml +++ b/definitions/ZonalTrafficSubscription.yaml @@ -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: diff --git a/definitions/ZoneInfo.yaml b/definitions/ZoneInfo.yaml index 8f74b65..4351320 100644 --- a/definitions/ZoneInfo.yaml +++ b/definitions/ZoneInfo.yaml @@ -1,4 +1,5 @@ description: A type containing zone information. +type: object required: - zoneId - numberOfAccessPoints diff --git a/definitions/ZoneList.yaml b/definitions/ZoneList.yaml index e5945c3..63168e7 100644 --- a/definitions/ZoneList.yaml +++ b/definitions/ZoneList.yaml @@ -1,4 +1,5 @@ description: Collection of the zone information list. +type: object required: - resourceURL properties: diff --git a/definitions/ZoneStatusNotification.yaml b/definitions/ZoneStatusNotification.yaml index 5d94491..6c439a6 100644 --- a/definitions/ZoneStatusNotification.yaml +++ b/definitions/ZoneStatusNotification.yaml @@ -1,3 +1,5 @@ +description: A type containing zone status notification. +type: object required: - zoneId - timestamp diff --git a/definitions/ZoneStatusSubscription.yaml b/definitions/ZoneStatusSubscription.yaml index 7c9ecb3..3e0790e 100644 --- a/definitions/ZoneStatusSubscription.yaml +++ b/definitions/ZoneStatusSubscription.yaml @@ -1,3 +1,5 @@ +description: A type containing zone status subscription. +type: object required: - callbackReference - zoneId diff --git a/definitions/index.yaml b/definitions/index.yaml index 03e08bb..db997a1 100644 --- a/definitions/index.yaml +++ b/definitions/index.yaml @@ -1,119 +1,80 @@ 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 diff --git a/externalDocs/index.yaml b/externalDocs/index.yaml index 132dc24..20a5a1b 100644 --- a/externalDocs/index.yaml +++ b/externalDocs/index.yaml @@ -1,2 +1,2 @@ - 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 diff --git a/info/index.yaml b/info/index.yaml index ba27da5..6cf6a33 100644 --- a/info/index.yaml +++ b/info/index.yaml @@ -1,6 +1,6 @@ - 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 diff --git a/parameters/Body.UserTrackingSubscription.yaml b/parameters/Body.UserTrackingSubscription.yaml new file mode 100644 index 0000000..62164ae --- /dev/null +++ b/parameters/Body.UserTrackingSubscription.yaml @@ -0,0 +1,6 @@ +name: userTrackingSubscription +in: body +description: User Tracking Subscription +required: true +schema: + $ref: '#/definitions/UserTrackingSubscription' \ No newline at end of file diff --git a/parameters/Body.ZonalTrafficSubscription.yaml b/parameters/Body.ZonalTrafficSubscription.yaml new file mode 100644 index 0000000..b33fcef --- /dev/null +++ b/parameters/Body.ZonalTrafficSubscription.yaml @@ -0,0 +1,6 @@ +name: zonalTrafficSubscription +in: body +description: Zonal Traffic Subscription +required: true +schema: + $ref: '#/definitions/ZonalTrafficSubscription' \ No newline at end of file diff --git a/parameters/Body.ZoneStatusSubscription.yaml b/parameters/Body.ZoneStatusSubscription.yaml new file mode 100644 index 0000000..7dfc296 --- /dev/null +++ b/parameters/Body.ZoneStatusSubscription.yaml @@ -0,0 +1,6 @@ +name: zoneStatusSubscription +in: body +description: Zone Status Subscription +required: true +schema: + $ref: '#/definitions/ZoneStatusSubscription' \ No newline at end of file diff --git a/parameters/Path.AccessPointId.yaml b/parameters/Path.AccessPointId.yaml new file mode 100644 index 0000000..d1f4b57 --- /dev/null +++ b/parameters/Path.AccessPointId.yaml @@ -0,0 +1,5 @@ +name: accessPointId +in: path +description: Access Point ID +required: true +type: string \ No newline at end of file diff --git a/parameters/Path.SubscriptionId.yaml b/parameters/Path.SubscriptionId.yaml new file mode 100644 index 0000000..9d9f9d0 --- /dev/null +++ b/parameters/Path.SubscriptionId.yaml @@ -0,0 +1,5 @@ +name: subscriptionId +in: path +description: Subscription ID +required: true +type: string \ No newline at end of file diff --git a/parameters/Path.UserId.yaml b/parameters/Path.UserId.yaml new file mode 100644 index 0000000..720237f --- /dev/null +++ b/parameters/Path.UserId.yaml @@ -0,0 +1,5 @@ +name: userId +in: path +description: User ID +required: true +type: string \ No newline at end of file diff --git a/parameters/Path.ZoneId.yaml b/parameters/Path.ZoneId.yaml new file mode 100644 index 0000000..8d2c719 --- /dev/null +++ b/parameters/Path.ZoneId.yaml @@ -0,0 +1,5 @@ +name: zoneId +in: path +description: Zone ID +required: true +type: string \ No newline at end of file diff --git a/parameters/AccessPointId.yaml b/parameters/Query.AccessPointId.yaml similarity index 100% rename from parameters/AccessPointId.yaml rename to parameters/Query.AccessPointId.yaml diff --git a/parameters/InterestRealm.yaml b/parameters/Query.InterestRealm.yaml similarity index 100% rename from parameters/InterestRealm.yaml rename to parameters/Query.InterestRealm.yaml diff --git a/parameters/ZoneId.yaml b/parameters/Query.ZoneId.yaml similarity index 100% rename from parameters/ZoneId.yaml rename to parameters/Query.ZoneId.yaml diff --git a/parameters/index.yaml b/parameters/index.yaml index 249147f..79aa650 100644 --- a/parameters/index.yaml +++ b/parameters/index.yaml @@ -1,6 +1,20 @@ -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 diff --git a/paths/SubsUserTrackId_Del.yaml b/paths/SubsUserTrackId_Del.yaml index 0752b6a..7666584 100644 --- a/paths/SubsUserTrackId_Del.yaml +++ b/paths/SubsUserTrackId_Del.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: diff --git a/paths/SubsUserTrackId_Get.yaml b/paths/SubsUserTrackId_Get.yaml index 8ec55f7..07445e7 100644 --- a/paths/SubsUserTrackId_Get.yaml +++ b/paths/SubsUserTrackId_Get.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: 200: diff --git a/paths/SubsUserTrackId_Put.yaml b/paths/SubsUserTrackId_Put.yaml index 845be5e..ab57b48 100644 --- a/paths/SubsUserTrackId_Put.yaml +++ b/paths/SubsUserTrackId_Put.yaml @@ -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: diff --git a/paths/SubsUserTrack_Post.yaml b/paths/SubsUserTrack_Post.yaml index d1c7021..8097c74 100644 --- a/paths/SubsUserTrack_Post.yaml +++ b/paths/SubsUserTrack_Post.yaml @@ -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: diff --git a/paths/SubsZonalTrafId_Del.yaml b/paths/SubsZonalTrafId_Del.yaml index 08e1dc2..69317c2 100644 --- a/paths/SubsZonalTrafId_Del.yaml +++ b/paths/SubsZonalTrafId_Del.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: diff --git a/paths/SubsZonalTrafId_Get.yaml b/paths/SubsZonalTrafId_Get.yaml index 7db22b1..904eef9 100644 --- a/paths/SubsZonalTrafId_Get.yaml +++ b/paths/SubsZonalTrafId_Get.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: 200: diff --git a/paths/SubsZonalTrafId_Put.yaml b/paths/SubsZonalTrafId_Put.yaml index 10a84a3..41cc486 100644 --- a/paths/SubsZonalTrafId_Put.yaml +++ b/paths/SubsZonalTrafId_Put.yaml @@ -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: diff --git a/paths/SubsZonalTraf_Post.yaml b/paths/SubsZonalTraf_Post.yaml index 37332ca..ad5f2bc 100644 --- a/paths/SubsZonalTraf_Post.yaml +++ b/paths/SubsZonalTraf_Post.yaml @@ -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: diff --git a/paths/SubsZoneStatId.yaml b/paths/SubsZoneStatId.yaml index 4f330a3..7507a83 100644 --- a/paths/SubsZoneStatId.yaml +++ b/paths/SubsZoneStatId.yaml @@ -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 diff --git a/paths/SubsZoneStatId_Del.yaml b/paths/SubsZoneStatId_Del.yaml index 08e1dc2..69317c2 100644 --- a/paths/SubsZoneStatId_Del.yaml +++ b/paths/SubsZoneStatId_Del.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: diff --git a/paths/SubsZoneStatId_Get.yaml b/paths/SubsZoneStatId_Get.yaml index 30b2cbd..bf09fe0 100644 --- a/paths/SubsZoneStatId_Get.yaml +++ b/paths/SubsZoneStatId_Get.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: 200: diff --git a/paths/SubsZoneStatId_Put.yaml b/paths/SubsZoneStatId_Put.yaml index a4358d9..1188324 100644 --- a/paths/SubsZoneStatId_Put.yaml +++ b/paths/SubsZoneStatId_Put.yaml @@ -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: diff --git a/paths/SubsZoneStat_Post.yaml b/paths/SubsZoneStat_Post.yaml index 527f156..eccb634 100644 --- a/paths/SubsZoneStat_Post.yaml +++ b/paths/SubsZoneStat_Post.yaml @@ -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: diff --git a/paths/UsersId_Get.yaml b/paths/UsersId_Get.yaml index 0dc6e99..f661b4a 100644 --- a/paths/UsersId_Get.yaml +++ b/paths/UsersId_Get.yaml @@ -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: diff --git a/paths/Users_Get.yaml b/paths/Users_Get.yaml index bce8763..2d57527 100644 --- a/paths/Users_Get.yaml +++ b/paths/Users_Get.yaml @@ -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: diff --git a/paths/ZonesIdApsId_Get.yaml b/paths/ZonesIdApsId_Get.yaml index 9ed91cd..e592eb8 100644 --- a/paths/ZonesIdApsId_Get.yaml +++ b/paths/ZonesIdApsId_Get.yaml @@ -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: diff --git a/paths/ZonesIdAps_Get.yaml b/paths/ZonesIdAps_Get.yaml index 7edf33c..a00ac7f 100644 --- a/paths/ZonesIdAps_Get.yaml +++ b/paths/ZonesIdAps_Get.yaml @@ -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: diff --git a/paths/ZonesId_Get.yaml b/paths/ZonesId_Get.yaml index 24d9b3b..ba5f74b 100644 --- a/paths/ZonesId_Get.yaml +++ b/paths/ZonesId_Get.yaml @@ -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: diff --git a/paths/Zones_Get.yaml b/paths/Zones_Get.yaml index 7682663..bc7abc4 100644 --- a/paths/Zones_Get.yaml +++ b/paths/Zones_Get.yaml @@ -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 -- GitLab