Commit af639506 authored by Michel Roy's avatar Michel Roy
Browse files

added v2.1.1 draft version

parent 6bafe099
Pipeline #4990 failed with stage
in 0 seconds
This diff is collapsed.
################################################################################
# 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
################################################################################
# Tags #
################################################################################
tags:
$ref: './tags/index.yaml'
################################################################################
# Parameters #
################################################################################
parameters:
$ref: './parameters/index.yaml'
################################################################################
# paths #
################################################################################
paths:
$ref: './paths/index.yaml'
################################################################################
# Definitions #
################################################################################
definitions:
$ref: './definitions/index.yaml'
\ No newline at end of file
This diff is collapsed.
...@@ -4,11 +4,10 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E ...@@ -4,11 +4,10 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E
## Online resources ## Online resources
* [Specification document](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/01.01.01_60/gs_mec013v010101p.pdf) * [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs013-location-api/raw/stf593/LocationAPI.yaml).
* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs013-location-api/raw/master/LocationAPI.yaml). * [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs013-location-api/raw/stf593/LocationAPI.yaml).
* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs013-location-api/raw/master/LocationAPI.yaml).
## License ## License
Unless specified otherwise, the content of this repository and the files contained are released under the BSD-3-Clause license. Unless specified otherwise, the content of this repository and the files contained are released under the BSD-3-Clause license.
See the attached LICENSE file or visit https://forge.etsi.org/legal-matters. See the attached LICENSE file or visit https://forge.etsi.org/legal-matters.
\ 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
type: string
example: "001010000000000000000000000000001"
\ No newline at end of file
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'
\ No newline at end of file
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'
\ No newline at end of file
description: Address of user (e.g. "sip" URI, "tel" URI, "acr" URI).
type: string
format: uri
example: "acr:192.0.2.1"
\ No newline at end of file
description: Reserved for future use.
type: string
\ No newline at end of file
description: CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common].
type: string
example: "1234"
\ No newline at end of file
description: Notification callback definition.
type: object
required:
- notifyURL
properties:
notifyURL:
$ref: '#/definitions/NotifyURL'
\ No newline at end of file
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"
\ No newline at end of file
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"
\ No newline at end of file
description: Contextual information of a user location (e.g., aisle, floor, room number, etc.)
type: string
example: "GroundFloor"
\ No newline at end of file
description: Zone ID
type: string
example: "zone01"
\ No newline at end of file
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"
\ No newline at end of file
description: Interest realm of access point (e.g. geographical area, a type of industry etc.).
type: string
example: "LA"
\ No newline at end of file
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
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"
\ No newline at end of file
description: The URL of your own listener application.
type: string
format: url
example: "http://clientApp.example.com/location_notifications/123456"
\ 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