Commit f5863647 authored by Jesus de Gregorio's avatar Jesus de Gregorio
Browse files

Delete TS29506_Aiot_Device_Profile_Data.yaml

parent 89bb1cfb
Loading
Loading
Loading
Loading
Loading
+0 −159
Original line number Diff line number Diff line
openapi: 3.0.0
info:
  title: 'Unified Data Repository Service API file for AIoT Device Profile Data'
  version: '-'
  description: |
    Unified Data Repository Service (AIoT Device Profile Data).
    The API version is defined in 3GPP TS 29.504.
    © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
    All rights reserved.

externalDocs:
  description: 3GPP TS 29.506 V0.0.0; 5G System; Usage of the Unified Data Repository services for AIoT Device Profile Data; Stage 3.
  url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.506/

paths:
  /aiot-profile-data/{aiotDevPerId}/device-profile-data:
    get:
      summary: retrieve the AIoT Device Profile Data of an AIoT Device
      operationId: QueryAiotDeiveProfileData
      tags:
        - AiotDeviceProfileData (Document)
      security:
        - {}
        - oAuth2ClientCredentials:
          - nudr-dr
        - oAuth2ClientCredentials:
          - nudr-dr
          - nudr-dr:aiot-profile-data:aiotDevPerId:device-profile-data:read
      parameters:
        - name: aiotDevPerId
          in: path
          description: AIoT device permanent Identifier
          required: true
          schema:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'
        - name: supported-features
          in: query
          description: Supported Features
          schema:
             $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
      responses:
        '200':
          description: Expected response to a valid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceProfileData'
        '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:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'

    patch:
      summary: modify the AIoT Device Profile Data of an AIoT Device
      operationId: ModifyAiotDeiveProfileData
      tags:
        - AiotDeviceProfileData (Document)
      security:
        - {}
        - oAuth2ClientCredentials:
          - nudr-dr
        - oAuth2ClientCredentials:
          - nudr-dr
          - nudr-dr:aiot-profile-data:aiotDevPerId:device-profile-data:modify
      parameters:
        - name: aiotDevPerId
          in: path
          description: AIoT device permanent Identifier
          required: true
          schema:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'
        - 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/json-patch+json:
            schema:
              type: array
              items:
                $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem'
        required: true
      responses:
        '204':
          description: Expected response to a valid request
        '403':
          description: modification is rejected
          content:
            application/problem+json:
              schema:
                $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
        '200':
          description: Expected response to a valid request
          content:
            application/json:
              schema:
                $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult'
        '400':
          $ref: 'TS29571_CommonData.yaml#/components/responses/400'
        '401':
          $ref: 'TS29571_CommonData.yaml#/components/responses/401'
        '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:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'


components:
  schemas:

# STRUCTURED DATA TYPES

    DeviceProfileData:
      description: An AIoT Device's profile data.
      type: object
      required:
        - aiotDevicePermanentId
      properties:
        aiotDevicePermanentId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'
        lastKnownAIOTF:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'


# ENUMS