TS29437_SS_SAnGroupManagement.yaml with CRs agreed in CT3#146 meeting.

openapi: 3.0.0

info:

  title: SAn Server Spatial Anchor Group Management Service

  version: 1.0.0-alpha.1

  description: |

    API for SAn Server Spatial Anchor Group Management Service.

    ©2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

    All rights reserved.

externalDocs:

  description: >

    3GPP TS 29.437 V20.0.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/

servers:

  - url: "{apiRoot}/ssan-sangm/v1"

    variables:

      apiRoot:

        default: https://example.com

        description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549.

security:

  - {}

  - oAuth2ClientCredentials: []

paths:

  /anchor-groups:

    post:

      summary: Create a new Spatial Anchor Group.

      operationId: CreateSpatialAnchorGroup

      tags:

        - Spatial Anchor Groups (Collection)

      requestBody:

        required: true

        content:

          application/json:

            schema:

              $ref: '#/components/schemas/SpatialAnchorGroup'

      responses:

        '201':

          description: >

            Created. The Spatial Anchor Group is successfully created and a representation of the

            created Individual Spatial Anchor Group resource shall be returned.

          content:

            application/json:

              schema:

                $ref: '#/components/schemas/SpatialAnchorGroup'

          headers:

            Location:

              description: Contains the URI of the newly created resource.

              required: true

              schema:

                type: string

        '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'

    get:

      summary: Retrieve spatial anchor group information.

      operationId: GetSpatialAnchorGroup

      tags:

        - Spatial Anchor Groups (Collection)

      parameters:

        - name: group-Ids

          in: query

          description: Contains the identifier(s) of the spatial anchor groups.

          schema:

              type: array

              items:

                type: string

              minItems: 1

        - name: spatial-anchor-profile

          in: query

          description: Indicates whether the response shall include the spatial anchor profiles.

          schema:

              type: boolean

      responses:

        '200':

          description: >

            OK. The requested Spatial Anchor Group Resources are returned.

          content:

            application/json:

              schema:

                type: array

                items:

                  $ref: '#/components/schemas/SpatialAnchorGroup'

                minItems: 1

        '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'

        '406':

          $ref: 'TS29122_CommonData.yaml#/components/responses/406'

        '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'

  /anchor-groups/{groupId}:

    parameters:

      - name: groupId

        in: path

        description: >

          Represents the identifier of the Individual Spatial Anchor Group resource.

        required: true

        schema:

          type: string

    get:

      summary: Retrieve an existing Individual Spatial Anchor Group Resource.

      operationId: GetIndSpatialAnchorGroup

      tags:

        - Individual Spatial Anchor Group (Document)

      responses:

        '200':

          description: >

            OK. The requested Individual Spatial Anchor Group resource is returned.

          content:

            application/json:

              schema:

                $ref: '#/components/schemas/SpatialAnchorGroup'

        '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'

        '406':

          $ref: 'TS29122_CommonData.yaml#/components/responses/406'

        '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'

    put:

      summary: Update an existing Individual Spatial Anchor Group resource.

      operationId: UpdateIndSpatialAnchorGroup

      tags:

        - Individual Spatial Anchor Group (Document)

      requestBody:

        required: true

        content:

          application/json:

            schema:

              $ref: '#/components/schemas/SpatialAnchorGroup'

      responses:

        '200':

          description: >

            OK. The Individual Spatial Anchor Group resource is successfully updated and

            a representation of the updated resource shall be returned in the response body.

          content:

            application/json:

              schema:

                $ref: '#/components/schemas/SpatialAnchorGroup'

        '204':

          description: >

            No Content. The Individual Spatial Anchor Group resource is successfully updated and no

            content is returned in the response body.

        '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'

    patch:

      summary: Modify an existing Individual Spatial Anchor Group resource.

      operationId: ModifyIndSpatialAnchorGroup

      tags:

        - Individual Spatial Anchor Group (Document)

      requestBody:

        required: true

        content:

          application/json:

            schema:

              $ref: '#/components/schemas/SpatialAnchorGroupPatch'

      responses:

        '200':

          description: >

            OK. The Individual Spatial Anchor Group resource is successfully modified and

            a representation of the updated resource shall be returned in the response body.

          content:

            application/json:

              schema:

                $ref: '#/components/schemas/SpatialAnchorGroup'

        '204':

          description: >

            No Content. The Individual Spatial Anchor Group resource is successfully modified and no

            content is returned in the response body.

        '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'

    delete:

      summary: Delete an existing Individual Spatial Anchor Group resource.

      operationId: DeleteIndSpatialAnchorGroup

      tags:

        - Individual Spatial Anchor Group (Document)

      responses:

        '204':

          description: >

            No Content. The Individual Spatial Anchor Group resource is successfully deleted.

        '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'

        '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:

      type: oauth2

      flows:

        clientCredentials:

          tokenUrl: "{tokenUrl}"

          scopes: {}

  schemas:

#

# STRUCTURED DATA TYPES

#

    SpatialAnchorGroup:

      description: >

        Represents the Spatial Anchors Group.

      type: object

      properties:

        groupId:

          $ref: '#/components/schemas/SpatialAnchorGroupId'

        groupDescription:

          type: string

        serviceArea:

          $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ServiceArea'

        valServiceInfo:

          $ref: 'TS29437_SS_SAnManagement.yaml#/components/schemas/VALServiceInfo'

        accessControlRules:

          $ref: 'TS29437_SS_SAnManagement.yaml#/components/schemas/AllowedRules'

        anchors:

          type: array

          items:

            $ref: 'TS29437_SS_SAnManagement.yaml#/components/schemas/SpatialAnchorId'

          minItems: 0

        suppFeat:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

      required:

        - valServiceInfo

        - anchors

    SpatialAnchorGroupPatch:

      description: >

        Represents modifications to a Spatial Anchor Group.

      type: object

      properties:

        groupDescription:

          type: string

        serviceArea:

          $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ServiceArea'

        valServiceInfo:

          $ref: 'TS29437_SS_SAnManagement.yaml#/components/schemas/VALServiceInfo'

        accessControlRules:

          $ref: 'TS29437_SS_SAnManagement.yaml#/components/schemas/AllowedRules'

        anchors:

          type: array

          items:

            $ref: 'TS29437_SS_SAnManagement.yaml#/components/schemas/SpatialAnchorId'

          minItems: 1

      anyOf:

        - required: [groupDescription]

        - required: [serviceArea]

        - required: [valServiceInfo]

        - required: [accessControlRules]

        - required: [anchors]

# SIMPLE DATA TYPES

#

    SpatialAnchorGroupId:

      type: string

#

# ENUMERATIONS

#

#

# Data types describing alternative data types or combinations of data types:

#