Blueprint Projects API Reporting Requirements
- Jeff Brower
- Sukhdev Kapur
- Jane Shen
Overview
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)
Who should fill in the API requirements form
- Akraino blueprint project PTLs should fill in the API info form, as a mandatory requirement for releases R4, R5, and R6
Procedure
Below are instructions for API information gathering:
- Download the API information form (Click to download) or you can use this link to fill out then download the form from Google Drive.
- Follow steps below to fill in the API info form
- Upload the form (link takes you to list of uploaded forms, below that is a drag and drop / browse area for uploading forms)
- 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)
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.
- 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.
Uploaded API Info Forms
R7 API Information Collection and Review Status
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.
| No. | R5 Project Names | API Subcommittee member assignment | Status | Notes |
| 1 | Brower | |||
| 2 | Brower | |||
| 3 | ||||
| 4 | Brower | Kural sent e-mail saying no changes for "ICN Blueprint R6 release" but not specifying which ICN BPs | ||
| 5 | ||||
| 6 | Brower | Info for ELIOT IOTGateway APIs: https://lf-akraino.atlassian.net/wiki/display/AK/ELIOT+R6+IOTGateway+API+documentation | ||
| 7 | Brower | |||
| 8 | Brower | |||
| 9 | Brower | |||
| 10 | ||||
| 11 | Micro MEC Ferenc Székely | Brower | ||
| 12 | Brower | |||
| 13 | Brower | |||
| 14 | 5G MEC/Slice System to Support Cloud Gaming, HD Video and Live Broadcasting Blueprint | Brower | ||
| 15 | Brower | |||
| 16 | ||||
| 17 | Brower | Info for EALTEdge APIs: | ||
| 18 | Brower | Note - PCEI Blueprint R6 API documentation located here (as of ): | ||
| 19 | Brower | |||
| 20 | ||||
| 21 | Brower | |||
| 22 | ||||
| 23 | Brower | |||
| 24 | Brower | |||
| 25 | Brower | |||
| 26 | ||||
| 27 | Brower | |||
| 28 | Brower | |||
| 29 | Robot Basic Architecture Based on SESS | Brower |
|
R7 API Review Meeting Minutes
R6 API Information Collection and Review Status
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.
| No. | R5 Project Names | API Subcommittee member assignment | Status | Notes |
| 1 | Brower | |||
| 2 | Brower | No API changes expected from R5, per Bart Dong in TSC meeting . Waiting for e-mail from Bart to confirm this | ||
| 3 | ||||
| 4 | Brower | Kural sent e-mail saying no changes for "ICN Blueprint R6 release" but not specifying which ICN BPs | ||
| 5 | No API changes from R5, per e-mail from Salvador Fuentes Jeff updated the R6 planning table page and cc'd Kural and TSC | |||
| 6 | Brower | No API changes from R5, per e-mail from Khemendra Kumar | Info for ELIOT IOTGateway APIs: https://lf-akraino.atlassian.net/wiki/display/AK/ELIOT+R6+IOTGateway+API+documentation | |
| 7 | Brower | No API changes from R5, per e-mail from Khemendra Kumar | ||
| 8 | Brower | |||
| 9 | Brower | |||
| 10 | ||||
| 11 | Micro MEC Ferenc Székely | Brower |
| |
| 12 | Brower | No API changes expected from R5, per Liya Yu in TSC meeting . Waiting for e-mail from Liya to confirm this. Confirmed in e-mail sent by Liya | ||
| 13 | Brower | No API changes from R5, per e-mail from ZhuMing Zhang | ||
| 14 | 5G MEC/Slice System to Support Cloud Gaming, HD Video and Live Broadcasting Blueprint | Brower | No API changes from R5, per e-mail from Eagan Fu | |
| 15 | Brower | |||
| 16 | No API changes expected from R5, per Leo Li in TSC meeting . Waiting for e-mail from Leo to confirm this Leo confirmed by e-mail | |||
| 17 | Brower | No API changes from R5, per e-mail from Khemendra Kumar | Info for EALTEdge APIs: | |
| 18 | Brower | Revised API info form sent to Oleg per his requirements (see API Subcommittee meeting minutes for details) | Note - PCEI Blueprint R6 API documentation located here (as of ): | |
| 19 | Brower | No changes from R5, per e-mail from HaiHui Wang | ||
| 20 | ||||
| 21 | Brower | |||
| 22 | ||||
| 23 | Brower | No API changes expected from R5, per TSC meeting discussion . Waiting for e-mail from Jason or Jack to confirm this. Update - API form uploaded by Jason , scheduled for review at API subcommittee meeting Approved by API subcommittee at weekly meeting | ||
| 24 | Brower | |||
| 25 | Brower | No API changes from R5, per e-mail from Muhammad Hamza | ||
| 26 | ||||
| 27 | Brower | |||
| 28 | Brower | Per e-mail from Colin Peters , blueprint consumes Kubernetes and EdgeX APIs API info form uploaded Scheduled for review by API subcommitte API info form reviewed and approved during API subcommittee meeting | ||
| 29 | Robot Basic Architecture Based on SESS | Brower | Per e-mail from Inoue Reo blueprint does not export or consume APIs API info form uploaded by Inoue Reo , scheduled for API subcommittee review Reviewed and approved by API subcommittee | They are uploading an API info form indicating no APIs, along with comments about possible future API usage |
R6 API Review Meeting Minutes
R5 API Information Collection and Review Status
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.
| No. | R5 Project Names | API Subcommittee member assignment | Status | Notes |
| 1 | Brower | Per notice from WANG Tao (Tucker Wang), no changes from R4 | ||
| 2 | Brower | Per e-mail from Bart 7Sep21, no changes from R4 | ||
| 3 | ||||
| 4 | Brower | Per notice from Kural 5Aug21, no change from R4 | ||
| 5 | ICN - Multi-Tenant Secure Cloud Native Platform Salvador Fuentes (Deactivated) | API form uploaded 24 May e-mail questions exchanged 20Jul21 Scheduled for review by API subcommittee API subcommittee review completed and info accepted | Ike asked about OpenAPI compliance. PTL indicates gRPC fits their needs and no plans for future OpenAPI compliance | |
| 6 | Brower | Per e-mail from Khemendra 26Aug21, no changes from R4 | ||
| 7 | Brower | Per e-mail from Khemendra 26Aug21, no changes from R4 | ||
| 8 | Brower | Per e-mail from Sukhdev 5Aug21, no change from R4 | ||
| 9 | Brower | Per e-mail from Ricardo 10Aug21, he uploaded R5 API info forms for both KNI blueprints, with no substantive changes from R4. The API subcommittee has a review scheduled for of the new API info forms and will update this table afterwards | Ricardo notes "the only difference with their previous R4 API form is they are now using: - Kubernetes 1.20 instead of 1.18 (OpenShift is Kubernetes, so both versions are correlated)" | |
| 10 | See above note | |||
| 11 | Micro MEC Ferenc Székely | Brower | Per e-mail from Liya Yu 21Sep21, no changes from R4 | |
| 12 | Brower | |||
| 13 | Brower | Tina mentioned during API subcommittee meeting there is no change to API info for the I-VICS blueprint. Sent e-mail 27Aug21 to Sihui Wang and Simmy Zhang to confirm. Confirmed by Sihui in e-mail 30Aug21 | ||
| 14 | 5G MEC/Slice System to Support Cloud Gaming, HD Video and Live Broadcasting Blueprint | Brower | Per e-mail from Eagan Fu 15Aug21, no change from R4 | |
| 15 | Brower | API info form uploaded , API subcommittee review scheduled for API info form reviewed | According to API info form, no APIs offered or consumed, as the Blueprint constructs and provides an Android cloud run-time environment for user applications. Suggest to ask a few questions on TSC call and verify our understanding. | |
| 16 | Per e-mail from Leo (li@socnoc.ai) 11Aug21, no change from R4 | Per Tina, Yihui Wang stepped down as PTL. They will hold a PTL election soon | ||
| 17 | Brower | Per e-mail from Khemendra 20Aug21, no changes from R4 | Khemendra notes they upgraded the upstream project (Edge Gallery version 1.1 from 0.9 version) and have uploaded an updated API form with API document and definition links for EdgeGallery version 1.1 | |
| 18 | Brower | Per API Subcommittee meeting 30Jul21, no change from R4 | PCEI R5 API Doc: | |
| 19 | Brower | Per e-mail from Zifan 8Aug21, no change from R4 | ||
| 20 | ||||
| 21 | Brower | Per e-mail from Prem 31Jul21, no "new features/bugs". Per e-mail from Prem 27Aug21, confirmed no new API changes | see notes in R4 table below | |
| 22 | ||||
| 23 | Brower | API info form uploaded to API subcommittee page , and currently under review, with email questions pending to blueprint team before voting to approve this blueprint as part of R5 "Batch 2" blueprints. Approved informally . | Smart Cities R5 API Document | |
| 24 | Brower | API info form uploaded by Asif , scheduled for review by API Subcommittee Reviewed completed and info accepted | ||
| 25 | Brower | Ashvin Kumar uploaded API info form. API subcommittee review scheduled for Review completed and info accepted | The form was originally uploaded 27Aug21 but had a file corruption issue | |
| 26 | ||||
| 27 | Brower | Per e-mail , Deepak is in process of uploading API info form Form uploaded , scheduled for API subcommittee review API info reviewed and approved by API subcommittee . The subcommittee e-mailed Deepak asking to attend 29Oct meeting and give more explanation about ETSI MEC interfaces in their Blueprint | Wiki page with API info: R5 API Document |
R5 API Review Meeting Minutes
R4 API Information Collection and Review Status
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.
| No. | R4 Project Names | API Subcommittee member assignment | Status | Notes |
| 1 | Jiafeng Zhu | Email sent: 10/10 replied Form uploaded 15Dec Scheduled for review by API subcommittee 21Dec 6:00p PST (22Dec 10:00a CST) Review discussion: BP will add PaaS APIs, re-upload form API subcommittee review completed and info accepted | ||
| 2 | Jane Shen | First round email exchange on 12/09 with instruction link sent. Form uploaded Scheduled for review by API subcommittee 21Dec 6:00p PST (22Dec 10:00a CST) Review discussion: BP will add PaaS APIs, re-upload form API subcommittee review completed and info accepte | ||
| 3 | Jane Shen | Email sent: 10/15 Form uploaded API subcommittee review completed and info accepted | ||
| 4 | Jiafeng Zhu Jane Shen | Form uploaded API subcommittee review completed and info accepted BP reviewed on TSC 16 Dec. | ||
| 5 | Jiafeng Zhu | Email sent: 10/10 and 10/15 Try to join their weekly meeting, but none was in the meeting Participated ELIOT weekly meeting 10/21, and demonstrated how to fill out the API Info Form Form uploaded Review completed during API subcommittee meeting 11Dec BP reviewed on TSC 16 Dec. | ||
| 6 | Jiafeng Zhu | Email sent: 10/10 and 10/15 Try to join their weekly meeting, but none was in the meeting Participated ELIOT weekly meeting 10/21, and demonstrated how to fill out the API Info Form Review completed during API subcommittee meeting 11Dec BP reviewed on TSC 16 Dec. | ||
| 7 | Jeff Brower | Form uploaded Scheduled for review at API subcommittee meeting 18Dec API subcommittee review completed and info accepted | ||
| 8 | Jane Shen | Form uploaded API subcommittee review completed and info accepted | ||
| 9 | Jane Shen | Form uploaded API subcommittee review completed and info accepted | ||
| 10 | Jane Shen | Email sent: 10/15 Email received Form uploaded API subcommittee review scheduled for API subcommittee review completed and info accepted | ||
| 11 | Jeff Brower (assignment transferred from Jiafeng Zhu 13Jan21) | Hechun replied by e-mail 12Jan, form is in progress Form uploaded API subcommittee review scheduled for API subcommittee review completed and info accepted | ||
| 12 | Jeff Brower (assignment transferred from Jiafeng Zhu 13Jan21) | Email sent 2Feb20 Hechun and Liya Yu, and 9Feb20 Hechun and Zhongwan Hao Form uploaded API subcommittee review scheduled for API Subcommittee completed and info accepted | ||
| 13 | 5G MEC/Slice System to Support Cloud Gaming, HD Video and Live Broadcasting Blueprint | Jane Shen | Email sent: 10/15 Form uploaded Reviewed by API subcommittee API subcommittee review completed and info accepted | |
| 14 | IEC Type 3: Android cloud native applications on Arm servers in edge for Integrated Edge Cloud (IEC) Blueprint Family | Jeff Brower | E-mail discussion 21Jan, they have no APIs consumed or exported but still need to fill out the form with BP name and explain current and future API status in the comments Form uploaded , reviewed by API subcommittee API subcommittee review completed and info accepted | |
| 15 | Jeff Brower | Jiafeng sent e-mail 27Oct, Yihui replied 28Oct Form uploaded Scheduled for review by API subcommittee 21Dec 6:00p PST (22Dec 10:00a CST) API subcommittee review completed and info accepted | ||
| 16 | Jane Shen | Email sent: 10/15; replied Form received by e-mail Form uploaded API subcommittee review completed and info accepted | ||
| 17 | Jane Shen | Email sent: 10/15 Form uploaded on 4Jan21 Scheduled for review at API subcommittee meeting API subcommittee review completed and info accepted | ||
| 18 | Jane Shen | Form uploaded API subcommittee review completed and info accepted | ||
| 19 | Jeff Brower (assignment transferred from Jiafeng Zhu 13Jan21) | Form uploaded API subcommittee review completed and info accepted | ||
| 20 | Ike Alisson | Have not joined their group meeting yet, as it is a double-conflict in meeting schedule. Will attempt to work with them offline. Received response email. Still need to follow up..... Prem replied by e-mail 12Jan, form is in progress Form uploaded API subcommittee review scheduled for API subcommittee review completed and info accepted | TSC Meeting Presentation, Feb2021 | |
| 21 | Jeff Brower | Form uploaded Scheduled for review by API subcommittee 11Dec Review completed during BP project meeting 11Dec. Updated API info form will be uploaded by Vladimir Suvorov Form uploaded by Vladimir Suvorov on 18 Dec, will be reviewed by API subcommittee on 8 Jan API subcommittee review completed and info accepted | Info received from BP technical members, and Jeff and Jane have attended their weekly meetings to understand their architecture and project API usage. Jeff has created an architecture diagram showing API, CLI, and GUI interfaces. An R4 release review meeting for the BP is scheduled for 9 Dec (Jeff will attend). | |
| 22 | Jiafeng Zhu | Email sent: 10/10 and 10/15 | This BP is not showing in the R4 Release Planning page |
R4 API Review Meeting Minutes
Here are R4 BP API review meeting minutes.