CAPIF_Logging_API_Invocation_API

This API enables the API exposing function to communicate with the CAPIF core function to log the information related to service API invocations.

OpenAPI

OpenAPI Version: 3.0.0

info

Title: CAPIF_Logging_API_Invocation_API

Description: This API enables the API exposing function to communicate with the CAPIF core function to log the information related to service API invocations.

Version: "1.0.0"

externalDocs

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/

servers

URL: '{apiRoot}/api-invocation-logs/v1'

Variables:

API Root:

Default: https://example.com

Description: apiRoot as defined in subclause 7.5 of 3GPP TS 29.222

paths

aefId and logs

Method: Post

Description: Creates a new log entry for service API invocations.

Parameters:

- name: aefId

In: path

Description: Identifier of the API exposing function

Required/Optional: true

Schema:

Type: string

Request Body:

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/InvocationLog'

Responses:

'201' Log of service API invocations provided by API exposing function successfully stored on the CAPIF core function.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/InvocationLog'

Headers:

Location:

Description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/api-invocation-logs/v1/{aefId}/logs/{logId}'

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'

aefId, logs and logId

Description: Creates a new log entry for service API invocations.

Parameters:

- name: aefId

In: path

Description: Identifier of the API exposing function

Required/Optional: true

Schema:

Type: string

- name: logId

In: path

Description: Identifier of individual log entry

Required/Optional: true

Schema:

Type: string

components

schemas

InvocationLog

Type: object

Properties:

aefId:

Type: string

Description: Identity information of the API exposing function requesting logging of service API invocations

apiInvokerId:

Type: string

Description: Identity of the API invoker which invoked the service API

logs:

Type: array

Items:

Reference: '#/components/schemas/Log'

minItems: 1

Description: Service API invocation log

supportedFeatures:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

Required:

- aefId

- apiInvokerId

- log

Log

Type: object

Properties:

apiId:

Type: string

Description: String identifying the API invoked.

apiName:

Type: string

Description: Name of the API which was invoked, it is set as {apiName} part of the URI structure as defined in subclause 4.4 of 3GPP TS 29.501.

apiVersion:

Type: string

Description: Version of the API which was invoked

resourceName:

Type: string

Description: Name of the specific resource invoked

uri:

Reference: 'TS29122_CommonData_API.yaml#/components/schemas/Uri'

protocol:

Reference: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/Protocol'

operation:

Reference: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/Operation'

result:

Type: string

Description: For HTTP protocol, it contains HTTP status code of the invocation

invocationTime:

Reference: 'TS29122_CommonData.yaml#/components/schemas/DateTime'

invocationLatency:

Reference: '#/components/schemas/DurationMs'

inputParameters:

Description: List of input parameters. Can be any value - string, number, boolean, array or object.

outputParameters:

Description: List of output parameters. Can be any value - string, number, boolean, array or object.

srcInterface:

Reference: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas//InterfaceDescription'

destInterface:

Reference: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/InterfaceDescription'

fwdInterface:

Type: string

Description: It includes the node identifier (as defined in IETF RFC 7239 of all forwarding entities between the API invoker and the AEF, concatenated with comma and space, e.g. 192.0.2.43:80, unknown:_OBFport, 203.0.113.60

Required:

- apiId

- apiName

- apiVersion

- resourceName

- protocol

- result

DurationMs

Type: integer

Description: Unsigned integer identifying a period of time in units of milliseconds.

Minimum: 0