Commit 62ef66df authored by tangudun's avatar tangudun
Browse files

Edit TS29222_CAPIF_Events_API.yaml with CRs agreed in CT3#142 meeting.

parent da328a98

TS29222_CAPIF_Events_API.yaml

+60 −3
Original line number Diff line number Diff line
@@ -6,10 +6,10 @@ info: 
    API for event subscription management.  

    © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  

    All rights reserved.

  version: "1.4.0-alpha.2"

  version: "1.4.0-alpha.3"



externalDocs:

  description: 3GPP TS 29.222 V19.2.0 Common API Framework for 3GPP Northbound APIs

  description: 3GPP TS 29.222 V19.4.0 Common API Framework for 3GPP Northbound APIs

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



servers:
@@ -391,6 +391,16 @@ components: 
          items:

            $ref: 'TS29222_CAPIF_API_Invoker_Management_API.yaml#/components/schemas/OnboardingCriteria'

          minItems: 1

        onboardedCount:

          type: array

          items:

            $ref: '#/components/schemas/ApiInvokerCount'

          minItems: 1

        discoveryCount:

          type: array

          items:

            $ref: '#/components/schemas/DiscoveryCount'

          minItems: 1



    AccessControlPolicyListExt:

      description: Represents the extension for access control policies.
@@ -441,6 +451,46 @@ components: 
        notificationDestination:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'



    ApiInvokerCount:

      type: object

      description: Represents the count data for onboarding.

      properties:

        apiId:

          type: string

        count:

          type: integer

          description: >

            Contains the number of times the API Invokers requested to onboard the service

            API(s) API.

      required:

        - apiId

        - count



    DiscoveryCount:

      type: object

      description: Represents the count data for discovery.

      properties:

        apiIds:

          type: array

          items:

            type: string

          minItems: 1

        discoveryReqCount:

          type: array

          items:

            type: integer

          minItems: 1

        discoveryRspCount:

          type: array

          items:

            type: integer

          minItems: 1

      required:

        - apiIds

      anyOf:

        - required: [discoveryReqCount]

        - required: [discoveryRspCount]



    CAPIFEvent:

      anyOf:

      - type: string
@@ -459,6 +509,8 @@ components: 
          - API_TOPOLOGY_HIDING_CREATED

          - API_TOPOLOGY_HIDING_REVOKED

          - API_INVOKER_ONBOARDING_CRITERIA_FAILED

          - SERVICE_API_ONBOARDED_BY_API_INVOKERS_COUNT

          - SERVICE_API_DISCOVERY_BY_API_INVOKERS_COUNT

      - type: string

        description: >

          This string provides forward-compatibility with future
@@ -495,3 +547,8 @@ components: 
          the service APIs after the service APIs are unpublished.

        - API_INVOKER_ONBOARDING_CRITERIA_FAILED: Events related to API Invoker onboarding criteria

          failed to be met. 

        - SERVICE_API_ONBOARDED_BY_API_INVOKERS_COUNT: Periodic event related to the number of times the

          API Invokers requested to onboard the targeted service API(s).

        - SERVICE_API_DISCOVERY_BY_API_INVOKERS_COUNT: Periodic event related to the number of times the

          API Invokers discovered the targeted service API(s).