CAPIF -> endpoints for NEF

JakaCijan · November 10, 2022, 2:17pm

CAPIF service discovery method on link below returns info about NEF.

EVOLVED-5G/SDK-CLI/blob/master/examples/netapp_capif_connector_examples.py

from evolved5g.sdk import CAPIFInvokerConnector, ServiceDiscoverer


def showcase_capif_connector():
    """
        This method showcases how one can use the CAPIFConnector class.
        This class is intended for use within the evolved5G Command Line interface.
        It is a low level class part of the SDK that is not required to use while creating NetApps
    """
    capif_connector = CAPIFInvokerConnector(folder_to_store_certificates="/home/alex/Projects/test_certificate_folder",
                                            capif_host="capifcore",
                                            capif_http_port="8080",
                                            capif_https_port="443",
                                            capif_netapp_username="test_netapp_22",
                                            capif_netapp_password="test_netapp_password",
                                            capif_callback_url="http://localhost:5000",
                                            description= "test_app_description",
                                            csr_common_name="test_app_common_name",
                                            csr_organizational_unit="test_app_ou",
                                            csr_organization="test_app_o",

This file has been truncated. show original

Return JSON is represented bellow.

It is a purpose to use this NEF info to construct NEF url for further communication (token, subscriptions…) with NET ?
Is NEF ipv4_addr in this version always 127.0.0.1 ?

Otherwise NEF url is constructed from e.g. env file, but in context of using CAPIF - maybe this is one of the core functionality to retrieve endpoint.

(I mentioned this during Wp4 call, so just to put in words)

alexandros.tzoumas · November 10, 2022, 4:13pm

That’s a good question @JakaCijan !
At the current version of the SKD 0.8.5 this is out of scope (the information in this json is not valid)

So these properties:

should be ignored and you should retrieve the NEF url from the .env file as you mention.

In any case what you are proposing is a feature improvement. Indeed it would be good the whole endpoint to be constructed automatically by this JSON.

At the moment if you initialize a ServiceDiscovered and call method retrieve_specific_resource_name it will automatically filter this Json and return you a relative NEF endpoint (ex. “/nef/api/v1/3gpp-monitoring-event/v1/{id}/subscriptions”) where you need to prepend the NEF url.

service_discoverer = ServiceDiscoverer(folder_path_for_certificates_and_capif_api_key,
capif_host,
capif_https_port)

partial_endpoint = service_discoverer.retrieve_specific_resource_name("/nef/api/v1/3gpp-monitoring-event/", “MONITORING_SUBSCRIPTIONS”)