You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 21 Next »

(Under Construction)

Overview

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

  • All R4 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.​


Who should fill in the API requirements form

  • Akraino blueprint project PTLs should fill in the API info form, as a mandatory requirement for R4.


Procedure

Below are instructions for API information gathering:

  1. Download the API information form (Click to download)
  2. Follow steps below to fill in the API info form
  3. Upload the form before  (Click to upload)
  4. The API subcommittee will review inputs and verify links. PTLs can check the result from TSC Release 4 planning table


You can select API categories by choosing values from drop down lists embedded in the Excel spreadsheet. If you believe your project API doesn't fit existing categories, please explain in the "Comments" field and specify how your project APIs would be better categorized. 

    • Additional information of any type may be added to the "Comments" field. Don't hesitate to let us know why specific APIs are fundamental / important to your project. 
    • Please double check all links that you've filled in the form, and make sure they link to the latest version of your project.
    • If you have no relevant APIs exported or consumed, please explain why this is the case in the Comments field.

Examples

Click here for KubeEdge Edge Service BP API Information Form Example 


Questions?

    • 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.



Uploaded API Info Forms

  File Modified
No files shared here yet.



  • No labels