Blueprint Projects API Reporting Requirements

• Motivation: improve customer access and knowledge for blueprint projects. Consistent and well-organized APIs with baseline information will increase Akraino adoption

• All project APIs will be organized and published on the API map page of the Akraino API Portal.  The API Portal will include both API map navigation and search capability, to allow customers to investigate APIs they may need

• In addition to blueprint projects' mandatory baseline API info, optional information about (a) telco network interface APIs, and (b) Kubernetes environment APIs info will be collected. This will be used to support one-stop API presentation, analysis, comparison, finding similar APIs, and sandbox/sample code

• The TSC has asked the API subcommittee to identify commonality between APIs, and possibly identify a “base” set of Akraino edge computing APIs. This is future work, under discussion

• This page contains API info for Releases R4-R6​, in reverse chronological order (i.e. most recent first)

• Akraino blueprint project PTLs should fill in the API info form, as a mandatory requirement for releases R4, R5, and R6

Below are instructions for API information gathering:

1. Download the API information form (Click to download) or you can use this link to fill out then download the form from Google Drive. 

2. Follow steps below to fill in the API info form

3. Upload the form (link takes you to list of uploaded forms, below that is a drag and drop / browse area for uploading forms)

4. The API subcommittee will review inputs and verify links. PTLs can check the results in the TSC Release 6 planning table (or previously TSC Release 5 planning table or TSC Release 4 planning table)

Open

Open

1.  

   • You can send your questions to API subcommittee mailing list api@lists.akraino.org

   • Or, leave comments at the bottom of this page

   • Join API subcommittee weekly meetings (Friday morning 9:00am PST https://zoom.us/j/294712016) if you'd like to discuss your APIs with us.

   • In case you don't use Microsoft Office, you can fill out the form in Google Doc https://docs.google.com/spreadsheets/d/e/2PACX-1vSbL0gDGuv1avvNSNTdpkeVP1yY-KDIjTYD_xPEIeQMMPxIu61S37ZYwr0nfyCco89EK6ikCATAjolW/pubhtml. However, you MUST download it from Google Doc and Upload to this page. 

Note – updates in this table are made by API subcommittee members only. PTLs should fill out the spreadsheet above, and then upload under "Uploaded API Info Forms" above.