Content for TS 23.222 Word version: 18.2.0

0… 4… 5… 6… 6.3… 6.4… 7… 8… 8.5… 8.8… 8.9… 8.13… 8.17… 8.21… 8.25… 8.28… 9… 10… 10.4… 10.7… 11… A B… B.2… B.3… C… D…

8.5 Retrieve service APIs 8.5.1 General 8.5.2 Information flows 8.5.2.1 Service API get request 8.5.2.2 Service API get response 8.5.3 Procedure 8.6 Update service APIs 8.6.1 General 8.6.2 Information flows 8.6.2.1 Service API update request 8.6.2.2 Service API update response 8.6.3 Procedure 8.7 Discover service APIs 8.7.1 General 8.7.2 Information flows 8.7.2.1 Service API discover request 8.7.2.2 Service API discover response 8.7.3 Procedure
...

8.5 Retrieve service APIs p. 45

8.5.1 General p. 45

The CAPIF supports retrieving the published service APIs information by the API provider. The API publishing function can be within PLMN trust domain or within 3rd party trust domain.

8.5.2 Information flows p. 45

8.5.2.1 Service API get request p. 45

Table 8.5.2.1-1 describes the information flow service API get request from the API publishing function to the CAPIF core function.

Table 8.5.2.1-1: Service API get request

Information Element	Status	Description
API publisher information	M	The information of the API publisher may include identity, authentication and authorization information
Service API published information reference	M	The information provided by the CAPIF core function which can be for referencing the information (set) about the published service API by the API publishing function.

8.5.2.2 Service API get response p. 46

Table 8.5.2.2-1 describes the information flow service API get response from the CAPIF core function to the API publishing function.

Table 8.5.2.2-1: Service API get response

Information Element	Status	Description
Result	M	Indicates the success or failure of retrieving the service API information
Service API information	O (1)	The service API information includes the service API name, service API type, communication type, description, Serving Area Information (optional), AEF location (optional), interface details (e.g. IP address, port number, URI), protocols, version numbers, and data format.
NOTE 1: Shall be present if the Result information element indicates that the service API get request is successful. Otherwise service API information shall not be present.

8.5.3 Procedure p. 46

Figure 8.5.3-1 illustrates the procedure for retrieving the service APIs. The service API retrieval mechanism is supported by the CAPIF core function.

Pre-condition:

Authorization details of the APF are available with the CAPIF core function.

Reproduction of 3GPP TS 23.222, Fig. 8.5.3-1: Retrieve service APIs

Figure 8.5.3-1: Retrieve service APIs

Step 1.

The API publishing function sends a service API get request to the CAPIF core function, with service API published information reference provided by the CAPIF core function when the service API was published.

Step 2.

Upon receiving the service API get request, the CAPIF core function checks whether the API publishing function is authorized to get published service APIs information. If the check is successful, the corresponding service API information is retrieved from the CAPIF core function (API registry).

Step 3.

The CAPIF core function provides a service API get response to the API publishing function which includes the service API information.

8.6 Update service APIs p. 47

8.6.1 General p. 47

The CAPIF core function allows the service API provider to update the information related to the published service API, e.g. a change in the characteristics of the service API. This procedure is initiated by the API publishing function to the CAPIF core function. The API publishing function can be within PLMN trust domain or within 3rd party trust domain.

8.6.2 Information flows p. 47

8.6.2.1 Service API update request p. 47

Table 8.6.2.1-1 describes the information flow service API update request from the API publishing function to the CAPIF core function.

Table 8.6.2.1-1: Service API update request

Information Element	Status	Description
API publisher information	M	The information of the API publisher may include identity, authentication and authorization information
Service API published information reference	M	The information (set) provided by the CAPIF core function about the published service API which can be used for reference by the API publishing function.
Service API information	M	The service API information includes the service API name, service API type, service API status (e.g. active, inactive), communication type, description, List of public IP ranges of UEs (optional), Serving Area Information (optional), AEF location (optional), interface details (e.g. IP address, port number, URI), protocols, version numbers, and data format which is required to replace the existing service API information
Reason	O	The reason of the update (e.g. change log)

8.6.2.2 Service API update response p. 47

Table 8.6.2.2-1 describes the information flow service API update response from the CAPIF core function to the API publishing function.

Table 8.6.2.2-1: Service API update response

Information Element	Status	Description
Result	M	Indicates the success or failure of updating the service API information.
Service API information	O	The authorized service API information during update, applicable when the update result is success.

8.6.3 Procedure p. 48

Figure 8.6.3-1 illustrates the procedure for updating the published service APIs information. The service API update mechanism is supported by the CAPIF core function.

Pre-conditions:

Authorization details of the APF are available with the CAPIF core function.
API invokers may have subscribed with the CAPIF core function to obtain notification regarding update to service API information.

Reproduction of 3GPP TS 23.222, Fig. 8.6.3-1: Update service APIs

Figure 8.6.3-1: Update service APIs

Step 1.

The API publishing function sends a service API update request to the CAPIF core function, which includes the service API published information reference provided by the CAPIF core function when the service API was published and the new service API information which is to be updated.

Step 2.

Upon receiving the service API update request, the CAPIF core function checks whether the API publishing function is authorized to update the published service APIs information. If the check is successful, the service API information provided by the API publishing function is updated at the CAPIF core function (API registry).

Step 3.

The CAPIF core function provides a service API update response to the API publishing function and triggers notifications to subscribed API invokers as described in subclause 8.8.4.

8.7 Discover service APIs p. 48

8.7.1 General p. 48

The following procedure in this subclause corresponds to the architectural requirements on discover service APIs.

8.7.2 Information flows p. 48

8.7.2.1 Service API discover request p. 48

Table 8.7.2.1-1 describes the information flow service API discover request from the API invoker to the CAPIF core function.

Table 8.7.2.1-1: Service API discover request

Information Element	Status	Description
API invoker identity information	M	Identity information of the API invoker discovering service APIs
Query information	M	Criteria for discovering matching service APIs (e.g. service API type, Serving Area Information (optional), preferred AEF location (optional), required API provider name (optional), UE IP address (optional), interfaces, protocols), Service KPIs (optional) (see NOTE)
NOTE 1: It should be possible to discover all the service APIs.

8.7.2.2 Service API discover response p. 49

Table 8.7.2.2-1 describes the information flow service API discover response from the CAPIF core function to the API invoker.

Table 8.7.2.2-1: Service API discover response

Information Element	Status	Description
Result	M	Indicates the success or failure of the discovery of the service API information
Service API information (see NOTE 2)	O (1)	List of service APIs corresponding to the request, including API description such as service API name, service API type, Serving Area Information (optional), interface details (e.g. IP address, port number, URI), protocols, version, data format, Service KPIs (optional).
CAPIF core function identity information	O (1)	Indicates the CAPIF core function serving the service API category provided in the query criteria
NOTE 1: The service API information or the CAPIF core function identity information or both shall be present if the Result information element indicates that the service API discover operation is successful. Otherwise both shall not be present. NOTE 2: If topology hiding is enabled for the service API, the interface details shall be the interface details of AEF acting as service communication entry point for the service API.

8.7.3 Procedure p. 49

Figure 8.7.3-1 illustrates the procedure for discover service APIs.

The service API discovery mechanism is supported by the CAPIF core function.

Pre-conditions:

The API invoker is onboarded and has received an API invoker identity.
The CAPIF core function is configured with a discovery policy information (e.g. to restrict discovery to category of APIs) for API invoker(s).

Reproduction of 3GPP TS 23.222, Fig. 8.7.3-1: Discover service APIs

Figure 8.7.3-1: Discover service APIs

Step 1.

The API invoker sends a service API discover request to the CAPIF core function. It includes the API invoker identity, and may include query information.

Step 2.

Upon receiving the service API discover request, the CAPIF core function verifies the identity of the API invoker (via authentication). The CAPIF core function retrieves the stored service API(s) information from the CAPIF core function (API registry) as per the query information in the service API discover request. Further, the CAPIF core function applies the discovery policy and performs filtering of service APIs information retrieved from the CAPIF core function.

Step 3.

The CAPIF core function sends a service API discover response to the API invoker with the list of service API information for which the API invoker has the required authorization.