API Governance

API Action Log.xlsx

Stage/ Checkpoint	I API Inception	II Requirements Gathering	III Build & Validate	IV General availability	V Adoption
Entry Criteria	JIRA Contribution	2 weeks prior of Spec Jam
Input	New API Proposal JIRA Backlog API Change Request Crowdsource Template	JIRA project space API Profile Template BA SID Mapping	JIRA Requirements API Profile BA Other docs as appropriate Swagger editor SID Mapping document	JSON schema & Swagger in Github Updated API Data Model (UML) SwaggerHub console available Developer Portal Updated Sanbdox running reference implementation Java code on Github	No of Hits on Developer Portal Number of mentions in social networks Adoption Survey
Process	New API Business Agreement (BA)OR new proposal Complete API Profile Template Governance Review Completion of the Crowdsource Template Existing API Change Request for API (BA Change OR New Reqmt) API Change Request Completed API Profile Template Governance Review Add API JIRA to next release schedule	Gather applicable documents Conduct Requirements Spec Jam or meetings (liaison, prior contributions, standards etc) Updated API Profile Template & BA Updated requirements into JIRA SID mapping requirements	Loading...	Marketing elements deployed in TM Forum website and other marketing vehicles such as newsletters & social networks TM Forum API Website updated CTK links available to wider audience Spec Lead follow up with issues/questions from developer community Announce companies which pass CTK	Develop Adoption Plan; identify targets Target and inform specific Development communities about the avialablity of the new API Target/organize Hackathons to support adoption Track/follow-up with members who are in Member Adoption Form Update Adoption List, Developer Portal, API Website Ensure publicity of API through all stages of development Identify and inform other ecosystems of API availability Conduct webinars driven by members to share experience in adoption
Output	Updated API Profile Template with reason for rejection or further clarification New JIRA project (for a CR there will be a new version of the project) Updated JIRA Release	Requirements in JIRA Appropriate postings for project Updated BA Updated SID Mapping template	Completed action list captured during Spec Jam Follow-up action plan created in Action Log Updated BA & JIRA Specifications stored in Confluence Reference implemention running in sandbox Reference implementation & JAVA Code in Github Developer Portal Updated TM Forum Web Page updated CTK - Level 0 & Level 1 available on Github Reviewed SID Mapping spec	JIRA Release updated Published Release Note	Adoption Report - CTK Adoption Statements Survey results
Links	API Change Request Template API Profile Template API Governance Rules API Charter Business Canvas API Crowdsource template	API REST Guidelines API Governance rules Member Adoption Form LOI Business Agreement Template API Profile Template API Data Model SID Mapping Rules and Guideline API Data Model SID Mapping Template	API Spec Template Action Log API Governance Rules Swagger Editor	Developer Portal Github Open API Table Link to collect questions & change requests form developer community (NEW!!!) (where should this be??)	Adoption Survey
					API Adoption Survey on Web Page (NEW!!!)



Checkpoint	Governance review	Governance rules & Guidelines adhered to	API Spec compliant with REST Guidelines and Template API Spec has been reviewed by Information Framework Team to make sure it is conformant with Information Framework API Data Model has documented mappings to SID API Spec is conformant with existing API Data Model for existing resources or data types.	JIRA Release	Governance and Business owner to refine steps to improve adoption
Exit pre-conditions	Resourcing available? Enough number of members/level of interest? Can a Spec Jam be done within the next 3 months? Have business drivers been established?	Governance guidelines & rules folllowed? API Profile Requirements are in JIRA? Sec Lead nominated?(optional in this stage, mandatory by Build stage)	4 weeks of member review completed? 2 weeks larger community review done? REST Guidelines followed? API Governance & Rules followed for all outputs? API Data Model is based on SID Concepts and CRs on SID are raised where applicable API Evolution Backlog and Change Requests in JIRA API conformant to Forum REST API Design Guidelines API Versioning Policies Use of Specification and Requirements Templates Deviations doucmented? Spec lead Nominated?
Cross-functional Implications	Cross review by Frameworx team	Review by API Program, Liaison, Community At Large, Frameworx, Impacted Projects (example ZOOM)	Frameworx, Impacted Projects, API Program, Liaison review Marketing message in place on all social networks
Actors- RACI	R, A - Members, Project teams, API Governance C - Frameworx team , Impacted API functional teams I - API program	R - Members, Project teams, API Governance , Spec Lead A - API Governance C - Frameworx Team, impacted API functional teams I - API program	R - Spec Lead, API Team A - API Governance C - Frameworx Team I - Conformance
Role Description	Spec Lead Can be nominated during Inception, Requirements or Build. Must be nominated by the time Build ends. Is from a Member company Is responsible for following up on questions, change requests etc which come from the communtiy. Must report back to Governance team on API status	API team/Impacted API functional Team Member of team working on a specific API; normally involved in all stages of the API API Program API Leadership Team Scrum master (for Spec Jam) Responsible for conduction a Spec Jam API Governance Comprised of members, and is responsible for ensuring process is followed, criteria are met, quality is maintained	Frameworx Team Member of Frameworx SID, TAM, eTOM Forum member Person belonging to a member company Liaison External organization with whom we have established a liaison agreement Conformance TM Forum Conformance team member	Project Team API Build team Impacted Project Strategic Program project which is impacted by the API

Space shortcuts

Page tree