Skip to content
LocationAPI.yaml 123 KiB
Newer Older
swagger: '2.0'
info:
  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.0
  title: MEC Location API
  termsOfService: TBD
  contact:
    name: TBD
    url: TBD
  license:
    name: ETSI MEC
    url: TBD
externalDocs:
  description: ETSI MEC013 V1.0.1 Location Service API
  url: 'https://docbox.etsi.org/ISG/MEC/70-Draft/0013LocationApi'
host: '127.0.0.1:8081'
basePath: /exampleAPI/location/v1/
schemes:
  - http
  - https
consumes:
  - application/json
produces:
  - application/json
parameters:
  ZoneId:
    name: zoneId
    in: query
    description: Zone ID
    required: true
    type: string
  AccessPointId:
    name: accessPointId
    in: query
    description: 'Identifier of access point, reference "definitions" for string format'
    required: false
    type: string
  InterestRealm:
    name: interestRealm
    in: query
    description: >-
      Interest realm of access point (e.g. geographical area, a type of industry
      etc.).
    required: false
    type: string
paths:
  /zones:
    get:
      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
          schema:
            properties:
              zoneList:
                description: Collection of the zone information list.
                required:
                  - resourceURL
                properties:
                  zone:
                    description: Collection of the zone information list.
                    type: array
                    items:
                      description: A type containing zone information.
                      required:
                        - zoneId
                        - numberOfAccessPoints
                        - numberOfUnservicableAccessPoints
                        - numberOfUsers
                        - resourceURL
                      properties:
                        zoneId:
                          description: Identifier of zone
                          type: string
                          example: zone01
                        numberOfAccessPoints:
                          description: The number of access points within the zone
                          type: integer
                          format: uint32
                          example: '10'
                        numberOfUnservicableAccessPoints:
                          description: Number of inoperable access points within the zone.
                          type: integer
                          format: uint32
                          example: '9'
                        numberOfUsers:
                          description: The number of users currently on the access point.
                          type: integer
                          format: uint32
                          example: '7'
                        resourceURL:
                          description: Self referring URL.
                          type: string
                          format: uri
                          example: >-
                            http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
                  resourceURL:
                    description: Self referring URL.
                    type: string
                    format: uri
                    example: >-
                      http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
          examples:
            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'
  '/zones/{zoneId}':
    get:
      description: Used to get the status of a zone.
      produces:
        - application/json
      parameters:
        - name: zoneId
          in: path
          description: Zone ID
          required: true
          type: string
      responses:
        '200':
          description: Successful response to a query regarding the status of a zone
          schema:
            properties:
              zoneInfo:
                description: A type containing zone information.
                required:
                  - zoneId
                  - numberOfAccessPoints
                  - numberOfUnservicableAccessPoints
                  - numberOfUsers
                  - resourceURL
                properties:
                  zoneId:
                    description: Identifier of zone
                    type: string
                    example: zone01
                  numberOfAccessPoints:
                    description: The number of access points within the zone
                    type: integer
                    format: uint32
                    example: '10'
                  numberOfUnservicableAccessPoints:
                    description: Number of inoperable access points within the zone.
                    type: integer
                    format: uint32
                    example: '9'
                  numberOfUsers:
                    description: The number of users currently on the access point.
                    type: integer
                    format: uint32
                    example: '7'
                  resourceURL:
                    description: Self referring URL.
                    type: string
                    format: uri
                    example: >-
                      http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
          examples:
            application/json:
              zoneInfo:
                zoneId: zone01
                numberOfAccessPoints: '3'
                numberOfUnserviceableAccessPoints: '1'
                numberOfUsers: '10'
                resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01'
  '/zones/{zoneId}/accessPoints':
    get:
      description: >-
        Access point status can be retrieved for sets of access points matching
        attribute in the request.
      produces:
        - application/json
      parameters:
        - name: zoneId
          in: path
          description: Zone ID
          required: true
          type: string
        - name: interestRealm
          in: query
          description: >-
            Interest realm of access point (e.g. geographical area, a type of
            industry etc.).
Loading full blame...