Commit 137ffcba authored by yadavra's avatar yadavra
Browse files

Edit TS29437_SS_SmManagement.yaml with agreed CRs in CT3#145 meeting.

parent 529b3a19
Loading
Loading
Loading
Loading
Loading
+119 −50
Original line number Diff line number Diff line
openapi: 3.0.0

info:
  title: SM Server Spatial Maps Management Service
  version: 1.0.0
  title: SM Server Spatial Map Management Service
  version: 1.0.1
  description: |
    API for Spatial Map Management Service.
    ©2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
@@ -10,7 +10,7 @@ info:

externalDocs:
  description: >
    3GPP TS 29.437 V19.0.0; Service Enabler Architecture Layer for Verticals (SEAL);
    3GPP TS 29.437 V19.1.0; Service Enabler Architecture Layer for Verticals (SEAL);
    Metaverse Enablement Services; Stage 3.
  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.437/

@@ -28,8 +28,8 @@ security:
paths:
  /spatial-maps:
    post:
      summary: Create a new Spatial Maps.
      operationId: CreateSpatialMaps
      summary: Create a new Spatial Map.
      operationId: CreateSpatialMap
      tags:
        - Spatial Maps (Collection)
      requestBody:
@@ -53,6 +53,55 @@ paths:
              required: true
              schema:
                type: string
        '202':
          description: >
            Accepted. The SM server has accepted the request and processing it.
            The assigned Spatial Map Identifier shall be returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpatialMapTempResp'
        '400':
          $ref: 'TS29122_CommonData.yaml#/components/responses/400'
        '401':
          $ref: 'TS29122_CommonData.yaml#/components/responses/401'
        '403':
          $ref: 'TS29122_CommonData.yaml#/components/responses/403'
        '404':
          $ref: 'TS29122_CommonData.yaml#/components/responses/404'
        '411':
          $ref: 'TS29122_CommonData.yaml#/components/responses/411'
        '413':
          $ref: 'TS29122_CommonData.yaml#/components/responses/413'
        '415':
          $ref: 'TS29122_CommonData.yaml#/components/responses/415'
        '429':
          $ref: 'TS29122_CommonData.yaml#/components/responses/429'
        '500':
          $ref: 'TS29122_CommonData.yaml#/components/responses/500'
        '503':
          $ref: 'TS29122_CommonData.yaml#/components/responses/503'
        default:
          $ref: 'TS29122_CommonData.yaml#/components/responses/default'
      callbacks:
        SpatialMapsNotif:
          '{$request.body#/notifUri}': 
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/SpatialMapsNotif'
              responses:
                '204':
                  description: >
                    No Content. The Spatial Maps Notification is successfully
                    received and acknowledged.
                '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':
@@ -88,10 +137,12 @@ paths:
            Contains the VAL application service identifier.
          schema:
            type: string
          required: true
        - name: map-id
          in: query
          description: >
            Contains the identifier of the spatial map.
          required: true
          content:
            application/json:
              schema:
@@ -370,6 +421,47 @@ paths:
          $ref: 'TS29122_CommonData.yaml#/components/responses/503'
        default:
          $ref: 'TS29122_CommonData.yaml#/components/responses/default'
      callbacks:
        SpatialMapsNotif:
          '{$request.body#/notifUri}': 
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/SpatialMapsNotif'
              responses:
                '204':
                  description: >
                    No Content. The Spatial Maps Notification is successfully
                    received and acknowledged.
                '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':
                  $ref: 'TS29122_CommonData.yaml#/components/responses/401'
                '403':
                  $ref: 'TS29122_CommonData.yaml#/components/responses/403'
                '404':
                  $ref: 'TS29122_CommonData.yaml#/components/responses/404'
                '411':
                  $ref: 'TS29122_CommonData.yaml#/components/responses/411'
                '413':
                  $ref: 'TS29122_CommonData.yaml#/components/responses/413'
                '415':
                  $ref: 'TS29122_CommonData.yaml#/components/responses/415'
                '429':
                  $ref: 'TS29122_CommonData.yaml#/components/responses/429'
                '500':
                  $ref: 'TS29122_CommonData.yaml#/components/responses/500'
                '503':
                  $ref: 'TS29122_CommonData.yaml#/components/responses/503'
                default:
                  $ref: 'TS29122_CommonData.yaml#/components/responses/default'

  /subscriptions/{subscriptionId}:
    parameters:
@@ -555,48 +647,6 @@ paths:
        default:
          $ref: 'TS29122_CommonData.yaml#/components/responses/default'

      callbacks:
        SpatialMapsNotif:
          '{$request.body#/notifUri}': 
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/SpatialMapsNotif'
              responses:
                '204':
                  description: >
                    No Content. The Spatial Maps Notification is successfully
                    received and acknowledged.
                '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':
                  $ref: 'TS29122_CommonData.yaml#/components/responses/401'
                '403':
                  $ref: 'TS29122_CommonData.yaml#/components/responses/403'
                '404':
                  $ref: 'TS29122_CommonData.yaml#/components/responses/404'
                '411':
                  $ref: 'TS29122_CommonData.yaml#/components/responses/411'
                '413':
                  $ref: 'TS29122_CommonData.yaml#/components/responses/413'
                '415':
                  $ref: 'TS29122_CommonData.yaml#/components/responses/415'
                '429':
                  $ref: 'TS29122_CommonData.yaml#/components/responses/429'
                '500':
                  $ref: 'TS29122_CommonData.yaml#/components/responses/500'
                '503':
                  $ref: 'TS29122_CommonData.yaml#/components/responses/503'
                default:
                  $ref: 'TS29122_CommonData.yaml#/components/responses/default'

components:
  securitySchemes:
    oAuth2ClientCredentials:
@@ -620,7 +670,7 @@ components:
           type: string
        areaInt:
            $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ServiceArea'
        notiUri:
        notifUri:
            $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
        mapInf:
            $ref: '#/components/schemas/SpatialMapCreateInfo'
@@ -787,6 +837,8 @@ components:
          $ref: '#/components/schemas/SpatialMapProfile'
        augLyrInf:
          $ref: '#/components/schemas/AugmentLayerInfo'
      required:
        - mapInf

    SpatialMapsSub:
      description: >
@@ -913,6 +965,7 @@ components:
          type: array
          items:
            $ref: '#/components/schemas/SpatialMapId'
          minItems: 1
        event:
          $ref: '#/components/schemas/MapEvent'
        objDet:
@@ -938,6 +991,19 @@ components:
      required:
        - objInf

    SpatialMapTempResp:
      description: >
        Represents the SM server has accepted the request and processing it. The assigned 
        Spatial Map Identifier shall be returned.
      type: object
      properties:
        mapId:
          $ref: '#/components/schemas/SpatialMapId'
        suppFeat:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
      required:
        - mapId

    AugmentLayerList:
      description: >
        Represents the list of augment layer values.
@@ -975,6 +1041,7 @@ components:
          - VAL_SERVER: Indicates that the spatial map layer augment information is VAL users.
          - VAL_CLIENT: Indicates that the spatial map layer augment information is Spatial
            Anchors.

    MapEvent:
      anyOf:
      - type: string
@@ -994,6 +1061,7 @@ components:
          - LAYERS_MODIFICATION: Indicates that the spatial map event is modification of spatial
            map layers.
          - SPATIAL_MAP_READY: Indicates that the spatial map event is spatial map ready.

    MapObjectChangeEvent:
      anyOf:
      - type: string
@@ -1018,3 +1086,4 @@ components:
          - ANY_OTHER: Indicates that the spatial map object is any other.
# Data types describing alternative data types or combinations of data types:
#