Commit 2b114bb1 authored by Jesus de Gregorio's avatar Jesus de Gregorio
Browse files

CT#108

parent 5df2309e
Loading
Loading
Loading
Loading
+256 −3
Original line number Diff line number Diff line
@@ -2,14 +2,14 @@ openapi: 3.0.0

info:
  title: LMS_LocationInformation
  version: 1.0.0-alpha.2
  version: 1.0.0-alpha.5
  description: |
    API for Requesting and subscribing on Location Information from LMS Service.  
    © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    All rights reserved.

externalDocs:
  description: 3GPP TS 24.283 V0.5.0; Mission Critical Location Management (MCLoc).
  description: 3GPP TS 24.283 V1.0.0; Mission Critical Location Management (MCLoc).
  url: http://www.3gpp.org/ftp/Specs/archive/24_series/24.283/

servers:
@@ -112,6 +112,190 @@ paths:
                default:
                  $ref: 'TS29571_CommonData.yaml#/components/responses/default'

  /subscriptions:
    post:
      description: Creates a new location subscription in the LMS.
      security: 
        - BearerAuth: []
      operationId: LMSsubscriptions
      tags:
        - Location Subscription Request (Collection)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocationSubscriptionRequest'
      responses:
        '201':
          description: Successful location subscription request submitted to LMS.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationSubscriptionRequest'
          headers:
            Location:
              description: Contains the URI of the newly created resource.
              required: true
              schema:
                type: string
        '400':
          $ref: 'TS29571_CommonData.yaml#/components/responses/400'
        '401':
          $ref: 'TS29571_CommonData.yaml#/components/responses/401'
        '403':
          $ref: 'TS29571_CommonData.yaml#/components/responses/403'
        '404':
          $ref: 'TS29571_CommonData.yaml#/components/responses/404'
        '411':
          $ref: 'TS29571_CommonData.yaml#/components/responses/411'
        '413':
          $ref: 'TS29571_CommonData.yaml#/components/responses/413'
        '415':
          $ref: 'TS29571_CommonData.yaml#/components/responses/415'
        '429':
          $ref: 'TS29571_CommonData.yaml#/components/responses/429'
        '500':
          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
        '503':
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'
      callbacks:
        subscriptionNotification:
          '{request.body#/subscriptionResponseUri}':
            post:
              requestBody: 
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/LocationNotification'
              responses:
                '204':
                  description: No Content (The receipt of the subscription notification
                    is acknowledged).
                '307':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/307'
                '308':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/308'
                '400':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/400'
                '401':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/401'
                '403':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/403'
                '404':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/404'
                '411':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/411'
                '413':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/413'
                '415':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/415'
                '429':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/429'
                '500':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/500'
                '503':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/503'
                default:
                  $ref: 'TS29571_CommonData.yaml#/components/responses/default'


  /subscriptions/{subscriptionId}:
    put:
      description: >
        Updates an existing location subscription identified by the subscriptionId.
      operationId: UpdateLocationSub
      tags:
        - Update Location subscription (Document)
      parameters:
        - name: subscriptionId
          in: path
          description: Identifies an individual location subscription resource.
          required: true
          schema:
            type: string
      requestBody:
        description: Parameters to replace the existing subscription.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocationSubscriptionRequest'
      responses:
        '200':
          description: >
            OK. The location subcsription resource was updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationSubscriptionRequest'
        '204':
          description: No Content (updated successfully).
        '400':
          $ref: 'TS29571_CommonData.yaml#/components/responses/400'
        '401':
          $ref: 'TS29571_CommonData.yaml#/components/responses/401'
        '403':
          $ref: 'TS29571_CommonData.yaml#/components/responses/403'
        '404':
          $ref: 'TS29571_CommonData.yaml#/components/responses/404'
        '411':
          $ref: 'TS29571_CommonData.yaml#/components/responses/411'
        '413':
          $ref: 'TS29571_CommonData.yaml#/components/responses/413'
        '415':
          $ref: 'TS29571_CommonData.yaml#/components/responses/415'
        '429':
          $ref: 'TS29571_CommonData.yaml#/components/responses/429'
        '500':
          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
        '503':
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'

    delete:
      description: >
        Deletes an location subscription identified by the subscriptionId.
      operationId: DeleteLocationSub
      tags:
        - Delete location Subscription (Document)
      parameters:
        - name: subscriptionId
          in: path
          description: Identifies an individual location subscription resource.
          required: true
          schema:
            type: string
      responses:
        '204':
          description: >
            A location subscription resource deleted successfully.
        '307':
          $ref: 'TS29571_CommonData.yaml#/components/responses/307'
        '308':
          $ref: 'TS29571_CommonData.yaml#/components/responses/308'
        '400':
          $ref: 'TS29571_CommonData.yaml#/components/responses/400'
        '401':
          $ref: 'TS29571_CommonData.yaml#/components/responses/401'
        '403':
          $ref: 'TS29571_CommonData.yaml#/components/responses/403'
        '404':
          $ref: 'TS29571_CommonData.yaml#/components/responses/404'
        '429':
          $ref: 'TS29571_CommonData.yaml#/components/responses/429'
        '500':
          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
        '503':
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'


components:
  securitySchemes:
    BearerAuth:
@@ -132,6 +316,11 @@ components:
            type: string
            format: uri
            description: A list of activated Functional Alias Id of requested MC Users.
        locationNotificationUri:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
        mclocClientID:
          type: string
          description: Identifies the LMC of the MC UE.
        mcServiceIds:
          type: array
          items:
@@ -139,15 +328,72 @@ components:
            format: uri
            description: A list of MC service IDs of the MC users for which 
              location information is requested MC Users.
        mcServiceGroupIds:
          type: array
          items:
            type: string
            format: uri
            description: A list of MC service Group IDs for which 
              location information is requested for the affiliated MC Users.
        refresh:
          type: boolean
          nullable: true
          description: The presence of this attribute indicates that the 
            location report shall be refreshed immediately.
        requestLocationHistory:
          $ref: 'TS24283_Lms_Registration.yaml#/components/schemas/RequestedLocationHistory'
        requestHistoryStatus:
          type: boolean
          description: This attributes indicates that a location history status report is requested.
      required:
        - mclocClientID
        - locationNotificationUri
      anyOf:
        - required: [functionalAliasIds]
        - required: [mcServiceIds]
        - required: [mcServiceGroupIds]


    LocationSubscriptionRequest:
      description: Represents a location subscription request.
      type: object
      properties:
        expTime:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
        functionalAliasIds:
          type: array
          items:
            type: string
            format: uri
            description: A list of Functional Alias Id which are actived for the MC Users
              for which location is subscribed.
        locationNotificationUri:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
        mclocClientID:
          type: string
          description: Identifies the LMC of the MC UE.
        mcServiceIds:
          type: array
          items:
            type: string
            format: uri
            description: A list of MC service IDs of the MC users for which 
              location information is subscribed MC Users.
        mcServiceGroupIds:
          type: array
          items:
            type: string
            format: uri
            description: A list of MC service Group IDs for which 
              location information is subscribed for the affiliated MC Users.
      required: 
        - expTime
        - mclocClientID
        - locationNotificationUri
      anyOf:
        - required: [functionalAliasIds]
        - required: [mcServiceIds]
        - required: [mcServiceGroupIds]

    MCUserLocation:
      description: Represents one MC User's device location information.
@@ -173,6 +419,9 @@ components:
            when multiple MC UEs are reporting by the same MC service user.
        locationInfo:
          $ref: 'TS24283_Lms_LocationReport.yaml#/components/schemas/LocationInfo'



    LocationNotification:
      description: Represents an location notification response.
      type: object
@@ -190,3 +439,7 @@ components:
          format: uri
          description: The activated Functional Alias Id of the LMC that requested
            the location report.
        subscriptionID:
          type: string
          description: Attribute including the subscriptionID when the location notification
            is related to an existing subscription.
+54 −4
Original line number Diff line number Diff line
@@ -2,14 +2,14 @@ openapi: 3.0.0

info:
  title: LMS_LocationReport
  version: 1.0.0-alpha.3
  version: 1.0.0-alpha.6
  description: |
    API for LocationReports to LMS Service.
    © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
    © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
    All rights reserved.

externalDocs:
  description: 3GPP TS 24.283 v0.5.0; Mission Critical Location Management (MCLoc).
  description: 3GPP TS 24.283 v1.0.0; Mission Critical Location Management (MCLoc).
  url: http://www.3gpp.org/ftp/Specs/archive/24_series/24.283/

servers:
@@ -105,7 +105,10 @@ components:
            type: string
            description: Attribute which can occur multiple times that contain the value 
              of the TriggerId attribute associated with a trigger that has fired.

        locationHistoryData:
          $ref: '#/components/schemas/LocationHistoryData'
        locationHistoryStatus:
          $ref: '#/components/schemas/LocationHistoryStatus'
    MclocClientId:
      type: string
      format: uuid
@@ -161,6 +164,53 @@ components:
          anyOf:
            - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Accuracy'



    LocationHistoryData:
      description: This object contains one or multiple time stamped location information reports.
      type: array
      items: 
        $ref: '#/components/schemas/LocationHistoryEvent'


    LocationHistoryEvent:
      description: This object respresents a single location information report that has been 
        stored in the LMC.
      type: object
      properties:
        locationData:
          $ref: '#/components/schemas/LocationInfo'
        locTimestamp:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
        triggerId:
          type: array
          items:
            type: string
            description: Attribute which can occur multiple times that contain the value 
              of the TriggerId attribute associated with a trigger that has fired.



    LocationHistoryStatus:
      description: This object respresents Location history summary status of the location reports
        that has been stored in the LMC and has not yet been reporeted.
      type: object
      properties:
        storedReports:
          type: integer
          description: set to the number of stored reports.
        startTime:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
        endTime:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
        triggerId:
          type: array
          items:
            type: string
            description: Attribute which can occur multiple times that contain the value 
              of the TriggerId attribute associated with a trigger that has fired.


#
# Simple Types:
#
+36 −5
Original line number Diff line number Diff line
@@ -2,14 +2,14 @@ openapi: 3.0.0

info:
  title: LMS_Registration
  version: 1.0.0-alpha.3
  version: 1.0.0-alpha.6
  description: |
    API for Registration to LMS Service.  
    © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    All rights reserved.

externalDocs:
  description: 3GPP TS 24.283 V0.5.0; Mission Critical Location Management (MCLoc).
  description: 3GPP TS 24.283 V1.0.0; Mission Critical Location Management (MCLoc).
  url: http://www.3gpp.org/ftp/Specs/archive/24_series/24.283/

servers:
@@ -270,6 +270,10 @@ components:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
        locationRequestUri:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
        pei:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei'
        supi:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
      required:
        - mclocClientID
        - expTime
@@ -295,13 +299,17 @@ components:
            MC user requesting to set the location configuration. 
        configScope:
          $ref: '#/components/schemas/ConfigScope'
        historyReporting:
          type: boolean
          description: The attribute indicates that the LMC shall store location
            information if location reporting can not be done, for example if the MC UE is out of
            coverage. The stored location information can be reported at a later time.




    TriggeringCriteria:
      description: Contains the location reporting trigger criteria used when the 
        MC UE is in emergency state.
      description: Contains the location reporting trigger criteria.
      type: object
      properties:
        adaptiveTrigger:
@@ -903,6 +911,11 @@ components:
            information is being requested.
        requestedLocationInfo:
          $ref: '#/components/schemas/RequestedLocationInfo'
        requestLocationHistory:
          $ref: '#/components/schemas/RequestedLocationHistory'
        requestHistoryStatus:
          type: boolean
          description: This attributes indicates that a location history status report is requested.



@@ -918,3 +931,21 @@ components:
          description: This string provides forward-compatibility with future extensions to the
            enumeration and is not used to encode content defined in the present version
            of this API.


    RequestedLocationHistory:
      description: Includes details on requested location history information
      type: object
      properties:
        numberOfReports:
          type: integer
          description: Indicates the number of requested stored reports.
        startTime:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
        endTime:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
        triggerCriteria:
          $ref: '#/components/schemas/TriggeringCriteria'
        minimumIntervalLength:
          type: integer
          description: Value in seconds, the minimum time between location reports.
+28 −4
Original line number Diff line number Diff line
@@ -2,14 +2,14 @@ openapi: 3.0.0

info:
  title: Eecs_ServiceProvisioning
  version: "1.2.0-alpha.2"
  version: "1.2.0-alpha.3"
  description: |
    API for ECS Service Provisioning.  
    © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    All rights reserved.

externalDocs:
  description: 3GPP TS 24.558 V19.2.0 Enabling Edge Applications; Protocol specification.
  description: 3GPP TS 24.558 V19.3.0 Enabling Edge Applications; Protocol specification.
  url: https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/

security:
@@ -146,6 +146,12 @@ paths:
            application/json:
              schema:
                $ref: '#/components/schemas/ECSServProvSubscription'
        '204':
          description: Successful case. No Content.
        '307':
          $ref: 'TS29122_CommonData.yaml#/components/responses/307'
        '308':
          $ref: 'TS29122_CommonData.yaml#/components/responses/308'
        '400':
          $ref: 'TS29122_CommonData.yaml#/components/responses/400'
        '401':
@@ -239,6 +245,12 @@ paths:
            application/json:
              schema:
                $ref: '#/components/schemas/ECSServProvSubscription'
        '204':
          description: Successful case. No Content.
        '307':
          $ref: 'TS29122_CommonData.yaml#/components/responses/307'
        '308':
          $ref: 'TS29122_CommonData.yaml#/components/responses/308'
        '400':
          $ref: 'TS29122_CommonData.yaml#/components/responses/400'
        '401':
@@ -285,6 +297,10 @@ paths:
        '204':
          description: >
            No Content (The requested service provisioning information does not exist).
        '307':
          $ref: 'TS29122_CommonData.yaml#/components/responses/307'
        '308':
          $ref: 'TS29122_CommonData.yaml#/components/responses/308'
        '400':
          $ref: 'TS29122_CommonData.yaml#/components/responses/400'
        '401':
@@ -496,7 +512,8 @@ components:
      properties:
        appGrpId:
          type: string
          description: Represents the application group that uniquely identifies
          description: >
            Represents the application group that uniquely identifies
            the group of UEs using the same application.
        easId:
          type: string
@@ -609,6 +626,12 @@ components:
          minItems: 1
          description: >
            Indicates the authentication methods supported by the EES.
        easBundleInfos:
          type: array
          items:
            $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EASBundleInfo'
          minItems: 1
          description: List of EAS bundles to which the EAS belongs.
        easBundleDetails:
          type: array
          items:
@@ -635,6 +658,7 @@ components:
      required:
        - easId
        - easBundleInfos

    EesAuthMethod:
      anyOf:
      - type: string
+6 −4
Original line number Diff line number Diff line
@@ -2,15 +2,15 @@ openapi: 3.0.0

info:
  title: Eees_ACREvents
  version: "1.1.0"
  version: "1.2.0-alpha.1"
  description: |
    API for ACR events subscription and notification.  
    © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    All rights reserved.

externalDocs:
  description: >
    3GPP TS 24.558 V18.5.1 Enabling Edge Applications; Protocol specification.
    3GPP TS 24.558 V19.3.0 Enabling Edge Applications; Protocol specification.
  url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/'

security:
@@ -359,7 +359,9 @@ components:
        - eventId

    TargetInfo:
      description: Details of the selected T-EAS and the T-EES.
      description: >
        Details of the selected T-EAS and the T-EES. The trgetEASInfo attribute shall be present,
        although they are not specified as a mandatory due to backward compatibility reasons.
      type: object
      properties:
        trgetEASInfo:
Loading