OpenAPI
OpenAPI Version: 3.0.0
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
OpenAPI Version: 3.0.0
Title: CAPIF_Events_API
Description: This API enables the Subscriber to communicate with the CAPIF core function to subscribe to and unsubscribe from CAPIF events, and receive subsequent notifications of CAPIF events.
Version: "1.0.0"
URL: '{apiRoot}/capif-events/v1'
Variables:
API Root:
Default: https://example.com
Description: apiRoot as defined in subclause 7.5 of 3GPP TS 29.222
Method: Post
Description: Creates a new individual CAPIF Event Subscription.
Parameters:
- Name: subscriberId
In: path
Description: Identifier of the Subscriber
Required/Optional: true
Schema:
Type: string
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/EventSubscription'
Callbacks:
notificationDestination:
'{request.body#/notificationDestination}':
Method: Post
Request Body: # contents of the callback message
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/EventNotification'
Responses:
'204':
Description: No Content (successful notification)
'400':
Reference: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
Reference: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
Reference: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
Reference: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
Reference: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
Reference: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
Reference: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
Reference: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29122_CommonData.yaml#/components/responses/503'
Default:
Reference: 'TS29122_CommonData.yaml#/components/responses/default'
Responses:
'201':
Description: Created (Successful creation of subscription)
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/EventSubscription'
Headers:
Location:
description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/capif-events/v1/{subscriberId}/subscriptions/{subscriptionId}'
Required/Optional: true
Schema:
Type: string
'400':
Reference: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
Reference: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
Reference: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
Reference: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
Reference: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
Reference: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
Reference: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
Reference: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29122_CommonData.yaml#/components/responses/503'
Default:
Reference: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
Description: Deletes an individual CAPIF Event Subscription.
Parameters:
- Name: subscriberId
In: path
Description: Identifier of the Subscriber
Required/Optional: true
Schema:
Type: string
- Name: subscriptionId
In: path
Description: Identifier of an individual Events Subscription
Required/Optional: true
Schema:
Type: string
Responses:
'204':
Description: The individual CAPIF Events Subscription matching the subscriptionId is deleted.
'400':
Reference: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
Reference: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
Reference: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29122_CommonData.yaml#/components/responses/404'
'429':
Reference: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
Reference: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29122_CommonData.yaml#/components/responses/503'
Default:
Reference: 'TS29122_CommonData.yaml#/components/responses/default'
schemas:
EventSubscription:
Type: object
Properties:
events:
Type: array
Items:
Reference: '#/components/schemas/CAPIFEvent'
minItems: 1
Description: Subscribed events
notificationDestination:
Reference: 'TS29122_CommonData.yaml#/components/schemas/Uri'
requestTestNotification:
Type: boolean
Description: Set to true by Subscriber to request the CAPIF core function to send a test notification as defined in in subclause 7.6. Set to false or omitted otherwise.
websockNotifConfig:
Reference: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'
supportedFeatures:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Required:
- events
- notificationDestination
EventNotification:
Type: object
Properties:
subscriptionId:
Type: string
Description: Identifier of the subscription resource to which the notification is related – CAPIF resource identifier
events:
Reference: '#/components/schemas/CAPIFEvent'
Required:
- subscriptionId
- events
CAPIFEvent:
anyOf:
- type: string
enum:
- SERVICE_API_AVAILABLE
- SERVICE_API_UNAVAILABLE
- SERVICE_API_UPDATE
- API_INVOKER_ONBOARDED
- API_INVOKER_OFFBOARDED
- SERVICE_API_INVOCATION_SUCCESS
- SERVICE_API_INVOCATION_FAILURE
- ACCESS_CONTROL_POLICY_UPDATE
- ACCESS_CONTROL_POLICY_UNAVAILABLE
- API_INVOKER_AUTHORIZATION_REVOKED
- type: string
Description:
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
Description:
Possible values are
- SERVICE_API_AVAILABLE: Events related to the availability of service APIs after the service APIs are published.
- SERVICE_API_UNAVAILABLE: Events related to the unavailability of service APIs after the service APIs are unpublished.
- SERVICE_API_UPDATE: Events related to change in service API information.
- API_INVOKER_ONBOARDED: Events related to API invoker onboarded to CAPIF.
- API_INVOKER_OFFBOARDED: Events related to API invoker offboarded from CAPIF.
- SERVICE_API_INVOCATION_SUCCESS: Events related to the successful invocation of service APIs.
- SERVICE_API_INVOCATION_FAILURE: Events related to the failed invocation of service APIs.
- ACCESS_CONTROL_POLICY_UPDATE: Events related to the update for the access control policy related to the service APIs. - ACCESS_CONTROL_POLICY_UNAVAILABLE: Events related to the unavailability of the access control policy related to the service APIs.
- API_INVOKER_AUTHORIZATION_REVOKED: Events related to the revocation of the authorization of API invokers to access the service APIs.
Description: 3GPP TS 29.222 V15.2.0 Common API Framework for 3GPP Northbound APIs
URL: http://www.3gpp.org/ftp/Specs/archive/29_series/29.222/