3GPP Individual EAS Deployment Information API

openapi: 3.2.0
info:
  title: 3gpp-eas-deployment Individual EAS Deployment Information API
  version: 1.2.0
  description: "API for AF provisioned EAS Deployment.  \n© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/3gpp-eas-deployment/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 EAS Deployment Information
paths:
  /{afId}/eas-deployment-info/{easDeployInfoId}:
    get:
      summary: Read an active Individual EAS Deployment Information resource for the AF
      operationId: ReadAnDeployment
      tags:
      - Individual EAS Deployment Information
      parameters:
      - name: afId
        in: path
        description: Identifier of the AF
        required: true
        schema:
          type: string
      - name: easDeployInfoId
        in: path
        description: Identifier of an EAS Deployment Information.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK (Successful get the active resource)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EasDeployInfo'
        '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: Fully updates/replaces an existing resource
      operationId: FullyUpdateAnDeployment
      tags:
      - Individual EAS Deployment Information
      parameters:
      - name: afId
        in: path
        description: Identifier of the AF
        required: true
        schema:
          type: string
      - name: easDeployInfoId
        in: path
        description: Identifier of the EAS Deployment information resource
        required: true
        schema:
          type: string
      requestBody:
        description: Parameters to update/replace the existing resource
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EasDeployInfo'
      responses:
        '200':
          description: OK (Successful update of the existing resource)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EasDeployInfo'
        '204':
          description: 'Successful case. The resource has been successfully updated and no additional content is  sent in the response message.

            '
        '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: Deletes an already existing EAS Deployment information resource
      operationId: DeleteAnDeployment
      tags:
      - Individual EAS Deployment Information
      parameters:
      - name: afId
        in: path
        description: Identifier of the AF
        required: true
        schema:
          type: string
      - name: easDeployInfoId
        in: path
        description: Identifier of the EAS Deployment information resource
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content (Successful deletion of the existing resource)
        '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:
  schemas:
    N6DelayMeasurementInfo:
      description: Contains N6 delay measurement assistance information.
      type: object
      properties:
        measureEndpointAddr:
          $ref: TS29571_CommonData.yaml#/components/schemas/IpAddr
        measureEndpointPort:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
        suppMeasProtocs:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/DelayMeasurementProtocol
          minItems: 1
          description: Contains the list of supported N6 delay measurement protocols.
        configParams:
          type: string
          description: 'Contains protocol-specific configuration parameters. The contents and the format are up to the implementation.

            '
      required:
      - measureEndpointAddr
    DnaiInformation:
      description: Represents DNAI information.
      type: object
      properties:
        dnai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnai
        dnsServIds:
          type: array
          items:
            $ref: '#/components/schemas/DnsServerIdentifier'
          minItems: 1
          description: 'Contains the list of DNS server identifier for each DNAI.

            '
        easIpAddrs:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/IpAddr
          minItems: 1
          description: 'Contains the IP address(s) of the EASs in the local DN for each DNAI.

            '
      required:
      - dnai
      anyOf:
      - required:
        - dnsServIds
      - required:
        - easIpAddrs
    N6DelayPerDnaiEas:
      description: Contains N6 delay measurement assistance information per DNAI and/or EAS.
      type: object
      properties:
        dnai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnai
        eas:
          $ref: TS29571_CommonData.yaml#/components/schemas/EasServerAddress
        n6DelayMeasureInfo:
          $ref: '#/components/schemas/N6DelayMeasurementInfo'
      required:
      - n6DelayMeasureInfo
      anyOf:
      - required:
        - dnai
      - required:
        - eas
    DnsServerIdentifier:
      description: Represents DNS server identifier (consisting of IP address and port).
      type: object
      properties:
        dnsServIpAddr:
          $ref: TS29571_CommonData.yaml#/components/schemas/IpAddr
        portNumber:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
      required:
      - dnsServIpAddr
      - portNumber
    EasDeployInfo:
      description: Represents EAS Deployment Information.
      type: object
      properties:
        self:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        afServiceId:
          type: string
          description: 'Contains a service on behalf of which the AF is issuing the request.

            '
        fqdnPatternList:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/FqdnPatternMatchingRule
          minItems: 1
          description: 'Contains the Supported FQDN pattern(s) for application(s) deployed in the Local part of the DN where each FQDN pattern is described by a FQDN Pattern Matching Rule.

            '
        appId:
          type: string
          description: 'Contains the application for which the EAS Deployment Information corresponds to.

            '
        dnn:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnn
        snssai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Snssai
        externalGroupId:
          $ref: TS29122_CommonData.yaml#/components/schemas/ExternalGroupId
        dnaiInfos:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DnaiInformation'
          minProperties: 1
          description: 'list of DNS server identifier (consisting of IP address and port) and/or IP address(s) of the EAS in the local DN for each DNAI. The key of map is the DNAI.

            '
        targetAfId:
          type: string
          description: 'Identifier of the AF that is responsible for the EAS associated with this EAS deployment information.

            '
        n6DelayPerDnaiEas:
          type: array
          items:
            $ref: '#/components/schemas/N6DelayPerDnaiEas'
          minItems: 1
          description: 'N6 delay measurement assistance information per DNAI and/or EAS.

            '
        suppFeat:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
      required:
      - fqdnPatternList
  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/