Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To validate an xApp descriptor, you can utilize either the CLI tool or the REST APIs of xapp onboarder.

...

  • A working RIC instance. Please refer to "RIC Installation Guide" for details.
  • xApp descriptor JSON file
  • Schema JSON file

Testing using xapp-onboarder RESTAPIs

  1. Find out the ingress IP for your RIC instance. If you deploy RIC using it/dep deployment script, it should be your host(VM)'s IP.
  2. We recommend to use postman for rest API calls.

    • Download postman
    • (optional) you can download and import our postman API collection file here. Set ingress_host to the INGRESS IP. ingress_port_http to 32080, xapp_onboard_path to /onboard, and appmgr_path to /appmgr

                    

View file
nameRIC xApp Onboard.postman_collection.json
height150

  1. Onboard xApp
    • Send a POST request to http://INGRESS_HOST:32080/onboard/api/v1/onboard
    • Header Content-Type is application/json
    • Body includes two entry:
      • config-file.json: The xapp descriptor JSON. Copy your xapp descriptor file content into the config-file.json section of the body.
      • controls-schema.json: The schema JSON for controls section. Copy the schema file into the controls-schema.json section of the body. (OPTIONAL, if you don't have controls section in your descriptor)Image Added
  2. (Optional)Download 

Testing using xapp-onboarder CLI tools

...