Commit e1c4eaec authored by jinghh's avatar jinghh
Browse files

Update TS29369_Nadm_DM.yaml after CT4#133

parent 9195ccfe
Loading
Loading
Loading
Loading
Loading
+160 −5
Original line number Diff line number Diff line
openapi: 3.0.0

info:
  version: '1.0.0'
  version: '1.0.1'
  title: 'Nadm_DM'
  description: |
    Nadm Data Management Service.  
    © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    © 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    All rights reserved.

externalDocs:
  description: 3GPP TS 29.369 Ambient IoT Data Management Services, version 19.1.0
  description: 3GPP TS 29.369 Ambient IoT Data Management Services, version 19.2.0
  url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.369/'

servers:
@@ -27,10 +27,17 @@ security:
paths:
  /aiot-device-profile-data/{aiotDevPermId}:
    get:
      summary: get AIoT Device Profile Data
      summary: get AIoT Device Profile Data for a give AIoT Device
      operationId: Get AIoT Device Profile Data
      tags:
        - AIoT Device Profile Data Retrieval
      security:
        - {}
        - oAuth2ClientCredentials:
          - nadm-dm
        - oAuth2ClientCredentials:
          - nadm-dm
          - nadm-dm:aiot-device-profile-data:read
      parameters:
        - name: aiotDevPermId
          in: path
@@ -74,10 +81,17 @@ paths:
        default:
          description: Unexpected error
    patch:
      summary: modify AIoT Device Profile Data
      summary: modify AIoT Device Profile Data for a give AIoT Device
      operationId: Modify AIoT Device Profile Data
      tags:
        - AIoT Device Profile Data Update
      security:
        - {}
        - oAuth2ClientCredentials:
          - nadm-dm
        - oAuth2ClientCredentials:
          - nadm-dm
          - nadm-dm:aiot-device-profile-data:modify
      parameters:
        - name: aiotDevPermId
          in: path
@@ -138,12 +152,140 @@ paths:
        default:
          description: Unexpected error

  /aiot-device-profile-data:
    get:
      summary: get AIoT Device Profile Data for a bundled AIoT Devices
      operationId: Get Bundled AIoT Device Profile Data
      tags:
        - Bundled AIoT Device Profile Data Retrieval
      security:
        - {}
        - oAuth2ClientCredentials:
          - nadm-dm
        - oAuth2ClientCredentials:
          - nadm-dm
          - nadm-dm:aiot-device-profile-data:read
      parameters:
        - name: requester-aiot-devices-id
          in: query
          description: a list of AIoT Device Permanent ID
          required: true
          style: form
          explode: false
          schema:
            type: array
            items:
              $ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'
            minItems: 1
      responses:
        '200':
          description: Expected response to a valid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiotDevProfileDataList'
        '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'
        '502':
          $ref: 'TS29571_CommonData.yaml#/components/responses/502'
        '503':
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          description: Unexpected error

    patch:
      summary: modify bundled AIoT Device Profile Data for bundled AIoT devices.
      operationId: Modify bundled AIoT Device Profile Data
      tags:
        - Bundled AIoT Device Profile Data Update
      security:
        - {}
        - oAuth2ClientCredentials:
          - nadm-dm
        - oAuth2ClientCredentials:
          - nadm-dm
          - nadm-dm:aiot-device-profile-data:modify
      parameters:
        - name: supported-features
          in: query
          description: Features required to be supported by the target NF
          schema:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              type: array
              items:
                $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem'
        required: true
      responses:
        '200':
          description: Expected response to a valid request
          content:
            application/json:
              schema:
                $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult'
        '204':
          description: Expected response to a valid request
        '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'
        '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'
        '502':
          $ref: 'TS29571_CommonData.yaml#/components/responses/502'
        '503':
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          description: Unexpected error

  /af-authorization-data:
    get:
      summary: get AF Authorization Data
      operationId: Get AF Authorization Data
      tags:
        - AF Authorization Data Retrieval
      security:
        - {}
        - oAuth2ClientCredentials:
          - nadm-dm
        - oAuth2ClientCredentials:
          - nadm-dm
          - nadm-dm:af-authorization-data:read
      parameters:
        - name: af-id
          in: query
@@ -309,6 +451,18 @@ components:
        tidHandlingInformation:
          type: boolean

    AiotDevProfileDataList:
      description: AIoT Device Profile Data of a list of AIoT devices.
      type: object
      required:
        - aiotDevProfileDataList
      properties:
        aiotDevProfileDataList:
          type: array
          items:
            $ref: '#/components/schemas/AiotDevProfileData'
          minItems: 1


#
# ENUMS
@@ -333,3 +487,4 @@ components:
            - STORED
            - CONCEALED
        - type: string