TS29574_Ndccf_ContextManagement.yaml

openapi: 3.0.0
info:
  version: 1.1.0-alpha.2
  title: Ndccf_ContextManagement
  description: |
    DCCF Context Management Service.  
    © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    All rights reserved.
externalDocs:
  description: 3GPP TS 29.574 V18.1.0; 5G System; Data Collection Coordination Services; Stage 3.
  url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.574/'
#
servers:
  - url: '{apiRoot}/ndccf-contextmanagement/v1'
    variables:
      apiRoot:
        default: https://example.com
        description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501.
#
security:
  - oAuth2ClientCredentials:
    - ndccf-contextmanagement
  - {}
#
paths:
  /data-collection-profiles:
    post:
      summary: Creates a new Individual DCCF Data Collection Profile resource.
      operationId: CreateDCCFDataCollectionProfile
      tags:
        - DCCF Data Collection Profiles (Collection)
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NdccfDataCollectionProfile'
        required: true
      responses:
        '201':
          description: A new Individual DCCF Data Collection Profile resource created.
          headers:
            Location:
              description: >
                Contains the URI of the newly created resource, according to the structure
                {apiRoot}/ndccf-contextmanagement/<apiVersion>/data-collection-profiles/{profileId}'
              required: true
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NdccfDataCollectionProfile'
        '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:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'
  /data-collection-profiles/{profileId}:
    delete:
      summary: Deletes an existing Individual DCCF Data Subscription resource.
      operationId: DeleteDCCFDataCollectionProfile
      tags:
        - Individual DCCF Data Collection Profile (Document)
      parameters:
        - name: profileId
          in: path
          description: >
            String identifying a data collection profile at the Ndccf_ContextManagement Service.
          required: true
          schema:
            type: string
      responses:
        '204':
          description: >
            No Content. The Individual DCCF Data Collection Profile resource matching the profileId
            was deleted.
        '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'
        '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'
    put:
      summary: Updates an existing Individual DCCF Data Collection Profile resource.
      operationId: UpdateDCCFDataCollectionProfile
      tags:
        - Individual DCCF Data Collection Profile (Document)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NdccfDataCollectionProfile'
      parameters:
        - name: profileId
          in: path
          description: >
            String identifying a data collection profile at the Ndccf_ContextManagement Service.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: >
            The Individual DCCF Data Collection Profile resource was modified successfully and a
            representation of that resource is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NdccfDataCollectionProfile'
        '204':
          description: >
            The Individual DCCF Data Collection Profile resource was modified successfully.
        '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:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'
#
components:
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{nrfApiRoot}/oauth2/token'
          scopes:
            ndccf-contextmanagement: Access to the ndccf-contextmanagement API
#
  schemas:

    NdccfDataCollectionProfile:
      description: Represents an Individual DCCF Data Collection Profile.
      type: object
      allOf:
        - oneOf:
          - required: [anaSub]
          - required: [dataSub]
        - oneOf:
          - required: [nwdafId]
          - required: [adrfId]
          - required: [nwdafSetId]
          - required: [adrfSetId]
      properties:
        anaSub:
          $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription'
        dataSub:
          $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataNotification'
        nwdafId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
        nwdafSetId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
        adrfId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
        adrfSetId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
        suppFeat:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
#