Commit 4016150f authored by Jesus de Gregorio's avatar Jesus de Gregorio
Browse files

CT#109

parent 3c169095
Loading
Loading
Loading
Loading
+52 −7
Original line number Diff line number Diff line
openapi: 3.0.0

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

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

servers:
  - url: '{apiRoot}/lms-location-information/v1'
  - url: '{apiRoot}/lms-information/v1'
    variables:
      apiRoot:
        default: https://example.com
@@ -74,7 +74,7 @@ paths:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'
      callbacks:
        locationRequestResponse:
          '{request.body#/locationRequestResponseUri}':
          '{request.body#/locationNotificationUri}':
            post:
              requestBody: 
                required: true
@@ -295,6 +295,51 @@ paths:
        default:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'

  /configrequest:
    post:
      description: Requests server to update location reporting configuraton for a target user
      security: 
        - BearerAuth: []
      operationId: configrequestLMC
      tags:
        - LMS Location Info Config Request (Collection)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: 'TS24283_Lms_Reporting.yaml#/components/schemas/LocationConfiguration'
      responses:
        '201':
          description: Successful configuration update request submitted to LMS
          content:
            application/json:
              schema:
                $ref: 'TS24283_Lms_Reporting.yaml#/components/schemas/LocationConfiguration'
        '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'



components:
  securitySchemes:
@@ -341,7 +386,7 @@ components:
          description: The presence of this attribute indicates that the 
            location report shall be refreshed immediately.
        requestLocationHistory:
          $ref: 'TS24283_Lms_Registration.yaml#/components/schemas/RequestedLocationHistory'
          $ref: 'TS24283_Lms_Reporting.yaml#/components/schemas/RequestedLocationHistory'
        requestHistoryStatus:
          type: boolean
          description: This attributes indicates that a location history status report is requested.
@@ -418,7 +463,7 @@ components:
          description: Used to identify the reporting MC UE for the end user, this may be used
            when multiple MC UEs are reporting by the same MC service user.
        locationInfo:
          $ref: 'TS24283_Lms_LocationReport.yaml#/components/schemas/LocationInfo'
          $ref: 'TS24283_Lms_Reporting.yaml#/components/schemas/LocationInfo'



TS24283_Lms_LocationReport.yaml

deleted100644 → 0
+0 −247
Original line number Diff line number Diff line
openapi: 3.0.0

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

externalDocs:
  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:
  - url: '{apiRoot}/lms-location-report/v1'
    variables:
      apiRoot:
        default: https://example.com
        description: apiRoot as defined in clause 8.2.44D1 of 3GPP TS 24.483

security:
  - BearerAuth: []

paths:
  /locationreports:
    post:
      summary: submit a MC UE location report
      security: 
        - BearerAuth: []
      operationId: submitLocationReport
      tags:
        - MC UE Location Report (Collection)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MCUELocation'
      responses:
        '201':
          description: Successful submission of location report.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MCUELocation'
        '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'

components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

# API specific definitions
  schemas:
    MCUELocation:
      description: Describes the parameters to perform LMS Location reports.
      type: object
      properties:
        functionalAlias:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
        interRatType:
          $ref: '#/components/schemas/InterRatType'
        locationData:
          $ref: '#/components/schemas/LocationInfo'
        locTimestamp:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
        mclocClientId:
          $ref: '#/components/schemas/MclocClientId'
        mcServiceUELabel:
          type: string
          description: Used to identify the reporting MC UE for the end users, this may be used
            when multiple MC UEs are used by the same MC service user.
        reportId:
          type: string
          description: Attribute is used to return the value in the RequestId attribute 
            in the an Location Request.
        reportType:
          $ref: '#/components/schemas/ReportType'
        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.
        locationHistoryData:
          $ref: '#/components/schemas/LocationHistoryData'
        locationHistoryStatus:
          $ref: '#/components/schemas/LocationHistoryStatus'
    MclocClientId:
      type: string
      format: uuid
      description: Used to identify the reporting LMC, this is required when multiple location
        information responses for different requested LMC are sent.

    LocationInfo:
      description: object that includes coordinates typically obtained from GPS.
      type: object
      properties:
        currentCoordinate:
          $ref: '#/components/schemas/CurrentCoordinate'
        ecgi:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi'
        mbmsSaiId:
          type: integer
          minimum: 0
          maximum: 65535
          description: Attribute containing the MBMS Service Area Id the LMC is located in.
        mbsfnArea:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsfnArea'
        ncgi:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi'
        neighbouringEcgi:
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi'
        neighbouringNcgi:
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi'
        nr5GMbsfsaArea:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsFsaId'

    CurrentCoordinate:
      description: This object contains one specific location point, speed and bearing (e.g., 
        received from a GPS reciever).
      type: object
      properties:
        altitude:
          anyOf:
            - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Altitude'
        bearingAndSpeed:
          anyOf:
            - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/HorizontalWithVerticalVelocity'
        geographicalCoordinate:
          anyOf:
            - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicalCoordinates'
        horizontalaccuracy:
          anyOf:
            - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Accuracy'
        verticalaccuracy:
          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:
#


#
# Enumeration data types
#
    InterRatType:
      description: Attribute containing the inter-RAT change type.
      anyOf:
        - type: string
          enum: 
            - 5G_MBS_TO_LTE_MBMS
            - 5G_MBS_TO_LTE_UNICAST
            - LTE_MBMS_TO_5G_MBS
            - LTE_MBMS_TO_5G_UNICAST
        - type: string
          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.

    ReportType:
      description: Used to inform whether the LMC is sending the report in an emergency
        situation or not.
      anyOf:
        - type: string
          enum: 
            - EMERGENCY
            - NONEMERGENCY
        - type: string
          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.
+261 −6
Original line number Diff line number Diff line
openapi: 3.0.0

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

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

servers:
  - url: '{apiRoot}/lms-registration/v1'
  - url: '{apiRoot}/lms-reporting/v1'
    variables:
      apiRoot:
        default: https://example.com
@@ -126,7 +126,7 @@ paths:
                  content:
                    application/json:
                      schema:
                        $ref: 'TS24283_Lms_LocationReport.yaml#/components/schemas/MCUELocation'
                        $ref: '#/components/schemas/MCUELocation'
                '307':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/307'
                '308':
@@ -246,6 +246,89 @@ paths:
        default:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'

  /locationreports:
    post:
      summary: submit a MC UE location report
      security: 
        - BearerAuth: []
      operationId: submitLocationReport
      tags:
        - MC UE Location Report (Collection)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MCUELocation'
      responses:
        '201':
          description: Successful submission of location report.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MCUELocation'
        '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'

  /configurations:
    get:
      summary: request to download the location configuration
      security: 
        - BearerAuth: []
      operationId: ConfigurationRequest
      tags:
        - LMC configurations (Collection)
      responses:
        '200':
          description: Successful submission of location report.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationConfiguration'
        '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'
        '406':
          $ref: 'TS29571_CommonData.yaml#/components/responses/406'
        '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:
@@ -949,3 +1032,175 @@ components:
        minimumIntervalLength:
          type: integer
          description: Value in seconds, the minimum time between location reports.


    MCUELocation:
      description: Describes the parameters to perform LMS Location reports.
      type: object
      properties:
        functionalAlias:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
        interRatType:
          $ref: '#/components/schemas/InterRatType'
        locationData:
          $ref: '#/components/schemas/LocationInfo'
        locTimestamp:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
        mclocClientId:
          $ref: '#/components/schemas/MclocClientId'
        mcServiceUELabel:
          type: string
          description: Used to identify the reporting MC UE for the end users, this may be used
            when multiple MC UEs are used by the same MC service user.
        reportId:
          type: string
          description: Attribute is used to return the value in the RequestId attribute 
            in the an Location Request.
        reportType:
          $ref: '#/components/schemas/ReportType'
        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.
        locationHistoryData:
          $ref: '#/components/schemas/LocationHistoryData'
        locationHistoryStatus:
          $ref: '#/components/schemas/LocationHistoryStatus'
    MclocClientId:
      type: string
      format: uuid
      description: Used to identify the reporting LMC, this is required when multiple location
        information responses for different requested LMC are sent.

    LocationInfo:
      description: object that includes coordinates typically obtained from GPS.
      type: object
      properties:
        currentCoordinate:
          $ref: '#/components/schemas/CurrentCoordinate'
        ecgi:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi'
        mbmsSaiId:
          type: integer
          minimum: 0
          maximum: 65535
          description: Attribute containing the MBMS Service Area Id the LMC is located in.
        mbsfnArea:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsfnArea'
        ncgi:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi'
        neighbouringEcgi:
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi'
        neighbouringNcgi:
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi'
        nr5GMbsfsaArea:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsFsaId'

    CurrentCoordinate:
      description: This object contains one specific location point, speed and bearing (e.g., 
        received from a GPS reciever).
      type: object
      properties:
        altitude:
          anyOf:
            - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Altitude'
        bearingAndSpeed:
          anyOf:
            - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/HorizontalWithVerticalVelocity'
        geographicalCoordinate:
          anyOf:
            - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicalCoordinates'
        horizontalaccuracy:
          anyOf:
            - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Accuracy'
        verticalaccuracy:
          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:
#


#
# Enumeration data types
#
    InterRatType:
      description: Attribute containing the inter-RAT change type.
      anyOf:
        - type: string
          enum: 
            - 5G_MBS_TO_LTE_MBMS
            - 5G_MBS_TO_LTE_UNICAST
            - LTE_MBMS_TO_5G_MBS
            - LTE_MBMS_TO_5G_UNICAST
        - type: string
          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.

    ReportType:
      description: Used to inform whether the LMC is sending the report in an emergency
        situation or not.
      anyOf:
        - type: string
          enum: 
            - EMERGENCY
            - NONEMERGENCY
        - type: string
          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.
+6 −6
Original line number Diff line number Diff line
@@ -2,15 +2,15 @@ openapi: 3.0.0

info:
  title: ETC_Configuration
  version: 1.0.2
  version: 1.1.0-alpha.1
  description: |
    API for event triggered network slice adaptation configuration.  
    © 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.549 V18.4.0 Application Data Analytics Enablement Service; Stage 3.
    3GPP TS 24.549 V19.0.0 Application Data Analytics Enablement Service; Stage 3.
  url: https://www.3gpp.org/ftp/Specs/archive/24_series/24.549/

security:
@@ -34,13 +34,13 @@ paths:
        - Event triggered network adaptation (Document)
      parameters:
        - name: valServiceId
          description: String identifying the resource.
          description: String identifies a VAL service resource.
          in: path
          required: true
          schema:
            type: string
        - name: configurationId
          description: String identifying the resource.
          description: String identifies a configuration resource.
          in: path
          required: true
          schema:
+3 −3
Original line number Diff line number Diff line
@@ -2,15 +2,15 @@ openapi: 3.0.0

info:
  title: NSCE_SliceInfo
  version: 1.0.1
  version: 1.1.0-alpha.1
  description: |
    API for notification of slice information.  
    © 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.549 V18.4.0 Network slice capability enablement- Service Enabler;
    3GPP TS 24.549 V19.0.0 Network slice capability enablement- Service Enabler;
    Architecture Layer for Verticals (SEAL); Protocol specification; Stage 3.
  url: https://www.3gpp.org/ftp/Specs/archive/24_series/24.549/

Loading