openapi: 3.2.0
info:
  title: 3gpp-ecs-address Individual Individual ECS Address Configuration Set (Document) API
  version: 1.1.0
  description: "API for AF provisioned ECS Address Configuration Information.  \n© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/3gpp-ecs-address/v1'
  variables:
    apiRoot:
      default: https://example.com
      description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
security:
- {}
- oAuth2ClientCredentials: []
tags:
- name: Individual Individual ECS Address Configuration Set (Document)
paths:
  /{afId}/configurations/{configId}:
    parameters:
    - name: afId
      in: path
      description: Represents the identifier of the AF.
      required: true
      schema:
        type: string
    - name: configId
      in: path
      description: 'Represents the identifier of the Individual ECS Address Configuration Information Set resource.

        '
      required: true
      schema:
        type: string
    patch:
      summary: Request the modification of an existing Individual ECS Address Configuration Information Set resource.
      operationId: ModifyEACI
      tags:
      - Individual Individual ECS Address Configuration Set (Document)
      requestBody:
        required: true
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/EcsAddrInfoPatch'
      responses:
        '200':
          description: 'OK. The Individual ECS Address Configuration Information Set resource is successfully modified and a representation of the updated resource is returned in the response body.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EcsAddrInfo'
        '204':
          description: 'No Content. The Individual ECS Address Configuration Information Set 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
components:
  schemas:
    EcsAddrInfoPatch:
      description: 'Represents the requested modifications to an ECS Address Configuration Information Set.

        '
      type: object
      properties:
        ecsServerAddr:
          $ref: TS29571_CommonData.yaml#/components/schemas/EcsServerAddr
        ecsAuthMethods:
          type: array
          items:
            $ref: TS29503_Nudm_PP.yaml#/components/schemas/EcsAuthMethod
          minItems: 1
        supportedPlmns:
          type: array
          items:
            $ref: TS29503_Nudm_PP.yaml#/components/schemas/SupportedPlmn
          minItems: 1
        spatialValidityCond:
          $ref: TS29571_CommonData.yaml#/components/schemas/SpatialValidityCond
    EcsAddrInfo:
      description: Represents an ECS Address Configuration Information Set.
      type: object
      properties:
        self:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        ecsServerAddr:
          $ref: TS29571_CommonData.yaml#/components/schemas/EcsServerAddr
        spatialValidityCond:
          $ref: TS29571_CommonData.yaml#/components/schemas/SpatialValidityCond
        dnn:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnn
        snssai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Snssai
        ecsAuthMethods:
          type: array
          items:
            $ref: TS29503_Nudm_PP.yaml#/components/schemas/EcsAuthMethod
          minItems: 1
        supportedPlmns:
          type: array
          items:
            $ref: TS29503_Nudm_PP.yaml#/components/schemas/SupportedPlmn
          minItems: 1
        suppFeat:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
      required:
      - ecsServerAddr
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{tokenUrl}'
          scopes: {}
externalDocs:
  description: '3GPP TS 29.522 V19.5.0; 5G System; Network Exposure Function Northbound APIs.

    '
  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/