Page tree


1. Project Information

* indicates that this field is required

Project Name*Open APIs
IPR Mode*
RAND

Explanations of each mode is available at http://www.tmforum.org/IPRPolicy/11525/home.html
Type of Project*Development Project
Strategic ProgramCloud Native IT & Networks
Previous Project CharterFirst Release
Project Workspace LinkOpen API Project Home
Project JIRA LinkSee Section 4 below
Project Sponsor
Project Team Chair*

Andreas Polz  - Beyond Now
Stephen Harrop  - Vodafone
Jonathan Goldberg- Amdocs
Kamal Maghsoudlou- Ericsson
Joel Burgess - Oracle

 TM Forum Staff Support

Ian Turkington - VP, Architecture and APIs
Pierre Gauthier - Chief API architect
Goutham Babu - API Product Owner
Henrique Rodrigues - Head of Labs and Software Development


2. Project Overview / Executive Summary



Mission

The increasingly complex multipartner digital services value chain raises new challenges in terms of ensuring time-to-market, seamless management, cost-effectiveness and revenue sharing. In order to meet these challenges, TM Forum members, including the world’s largest service providers and suppliers, have developed a standard set of Open APIs that simplify interoperability and enable the open digital ecosystem and provide critical management functionality to digital services.

The Open API project develops and maintains the Open APIs and the Open API architecture in response to market, business model and technology changes.

Value

TM Forum's Open Digital Architecture (ODA) if a collective vision for our industry. It offers an industry-agreed blueprint, language and set of key design principles to follow. It addresses a wide range of challenges brought about by market, business model and technology changes. And will enable service providers to deliver at speed, quickly respond to changes, simplify the building of partner ecosystems, strengthen and simplify the procurement process, support zero touch operations, and reduce total cost of ownership.

The Open API project provides the Open APIs and Data Model to enable interoperability within ODA.

Strategy

The Open API project will maintain existing Open APIs and develop new Open APIs, and the associated Data Model, in response to market, business and technology changes. The project will also develop the Open API architecture, primarily in response to technology developments.


3. Participants

This section identifies the project team members.

* indicates that this is a required field or role.

RoleName*Company* Confluence “@” mentionComments
Project Team Chair*

Andreas Polz
Stephen Harrop
Jonathan Goldberg
Kamal Maghsoudlou
Joel Burgess

BearingPoint
Vodafone
Amdocs
Ericsson
Oracle


TM Forum Theme 

Ian Turkington

TM Forum
Project ManagerGoutham BabuTM Forum
Subject Matter ExpertPierre GauthierTM ForumPierre Gauthier


4. Project Workstreams and Deliverables

The project workstreams and deliverables for this project are introduced in the sections below.

Workstream details

Workstream

Description

API Inception 

Introduction- The API Inception will serve as the foundation for all APIs (i.e) API profiles (eg: CaaS, ZTP..etc), Components and Frameworx.

Purpose - Is to bring all key stakeholders together, align on the goals and objectives of the project, and lay out a plan for moving forward.

Action - Attendees may discuss the project scope, timeline, risks, and any other critical information that is needed to ensure the project is executed successfully. It is also an opportunity to clarify roles and responsibilities, establish a clear line of communication, and ensure that everyone is on the same page.

Outcome - Is typically a shared understanding of the project and a plan for moving forward. 

API Tooling 

Introduction - The API Tooling meeting is a meeting held to discuss and make decisions about the tools and technology used to develop, manage, and publish APIs.

Purpose - Is to ensure that the right tools and technology are in place to support the development and management of APIs, and that they are used in an efficient and effective manner.

Action - Attendees may discuss topics such as API development frameworks, API management platforms, API documentation tools, and testing and debugging tools. The meeting may also involve the evaluation and selection of new tools and technology, as well as the discussion of any issues or limitations with existing tools.

Outcome of an API Tooling meeting is typically a set of agreed-upon tools and technology that will be used for API development, management, and publication. The meeting is an important step in ensuring that the right tools and technology are in place to support the API development process, and it helps to ensure that APIs are developed and managed in an efficient and effective manner.

API Governance

Introduction- The API Governance meeting is a meeting held to discuss and make decisions about the governance of APIs (Application Programming Interfaces) within the project.

Purpose - Is to ensure that APIs are aligned with the member's goals, standards, and best practices, and that they are designed, developed, and managed in a consistent and effective manner.

Action - Attendees may discuss such as API design standards, API lifecycle management, API security, API documentation, and API usage policies. The meeting may also involve review and approval of new API designs, updates to existing APIs, and the resolution of any API-related issues.

Outcome - Is typically a set of agreed-upon policies and guidelines for the development, deployment, and management of APIs within the program. 

API Team

Introduction- The API Team Meeting is a meeting held among the members of the API development team.

Purpose - Is to review the progress of ongoing API projects, discuss any challenges or roadblocks, and coordinate the work of the team.

Action -  Attendees may discuss topics such as the status of ongoing API projects, updates on new features and functionality, technical challenges, and resource allocation. The meeting may also involve the review of code and design documents, as well as the discussion of testing and quality assurance processes.

Outcome - Is typically a shared understanding of the progress and status of API projects, as well as a plan for moving forward. The meeting is an important step in ensuring that the API development team is aligned and working effectively towards common goals, and it helps to keep the team on track and focused on delivering high-quality APIs.

API architecture, usage patterns, design guidelines and DCS

Introduction- The API Architecture, Usage Patterns, and Design Guidelines meeting is a meeting held to discuss and make decisions about the design and development of APIs.

Purpose - Is to ensure that APIs are designed and developed in a way that meets the needs of the stakeholders, is scalable, and supports efficient and effective usage.

Action - Attendees may discuss topics such as API design patterns, RESTful API design principles, API data models, and API performance and scalability. The meeting may also involve the review of existing API designs and the development of new design guidelines.

Outcome - Is typically a set of agreed-upon API architecture, usage patterns, and design guidelines that will be used to guide the development of APIs within the organization. The meeting is an important step in ensuring that APIs are designed and developed in a consistent and effective manner that supports the needs of the stakeholders and is scalable.

API Specification Development - East

Introduction- The API Specification Development meeting is a meeting held to discuss and develop the specifications for a new or existing APIs.

Purpose - Is to ensure that the API meets the needs of the stakeholders and is designed in a way that supports its intended use.

Action - Attendees may discuss topics such as the API's functional requirements, data models, security and authentication mechanisms, error handling, and performance requirements. The meeting may also involve the review of existing API designs and the discussion of any potential changes or modifications.

Outcome - Is typically a detailed API specifications that outlines the functional and technical requirements of the API. This serves as a blueprint for the API development team and is used to guide the development and testing of the API.
This meeting is an important step in the API development process and helps to ensure that the API is developed in a way that supports its intended use and meets the needs of the users.

API Specification Development - West

Introduction- The API Specification Development meeting is a meeting held to discuss and develop the specifications for a new or existing APIs.

Purpose - Is to ensure that the API meets the needs of the stakeholders and is designed in a way that supports its intended use.

Action - Attendees may discuss topics such as the API's functional requirements, data models, security and authentication mechanisms, error handling, and performance requirements. The meeting may also involve the review of existing API designs and the discussion of any potential changes or modifications.

Outcome - Is typically a detailed API specifications that outlines the functional and technical requirements of the API. This serves as a blueprint for the API development team and is used to guide the development and testing of the API.
This meeting is an important step in the API development process and helps to ensure that the API is developed in a way that supports its intended use and meets the needs of the users.


Deliverable Status - https://projects.tmforum.org/jira/secure/Dashboard.jspa?selectPageId=12102



Sprint 2023-4

Key T Summary Value Statement Assignee Status
Loading...
Refresh

5. Backlog

T Key Summary Assignee Reporter P Status Resolution Created Updated Due
Loading...
Refresh


6. Legal Notice

Copyright © TM Forum 2023. All Rights Reserved.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to TM FORUM, except as needed for the purpose of developing any document or deliverable produced by a TM FORUM Collaboration Project Team (in which case the rules applicable to copyrights, as set forth in the TM FORUM IPR Policy, must be followed) or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by TM FORUM or its successors or assigns.

This document and the information contained herein is provided on an "AS IS" basis and TM FORUM DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Direct inquiries to the TM Forum office:

181 New Road, Suite 304
Parsippany, NJ 07054 USA
Tel No. +1 862 227 1648
TM Forum Web Page: www.tmforum.org

  • No labels