Playbook

How do I specify and submit a proposal for a new API or API Suite?

Playbook Summary:

Contribute new, innovative or alternative APIs or API Suites to the extensive TM Forum Open API library. Collaborate with others to test, inform and enhance your ideas.

Join the TM Forum API Project

Learn how to join the TM Forum API project and submit a request to do so.

How to join the API Project

Consult TM Forum API Design Guidelines and capture your requirements.

Utilize TM Forum REST API Design Guidelines and work with the API Project Team to capture your API requirements in the TM Forum Standard Profile Template.

TMF630 REST API Design Guidelines 4.2.0

TMF428 Profile Template

Submit your proposal

Submit your proposed API or API Suite as a JIRA Project Contribution.

Present your proposal at an API Development Meeting.

Book a slot on the API Development Meeting agenda to present your proposal to the API team for review and comment. These weekly calls are currently scheduled on Mondays at 14:00 Central European Time (CET) but you will have been invited to the relevant regular project meetings when your request to join the project was accepted.

Obtain approval for for publication.

Once your Profile document has been approved by the API Project Team and the Chief API Architect, it will be submitted for publication..

Create and publish the Swagger file.

The next step in the API development process is to create a Swagger file, based on the requirements, schema definition and rules file. Once approved by the API Project Team and Chief API Architect, the Swagger is added to the Open API Table - Early Adoption (Beta), with a link to the public GitHub (Apache 2.0).

Open API Table - Early Adoption (Beta)

Generate and publish the API User Guide.

Use the Swagger to auto-generate the API User Guide, including UML diagrams. Once approved by the API Project Team and Chief API Architect, the API User Guide is published and added to the Open API Directory - Preview.

Open API Directory - Preview

Create and publish the API conformance profile

Create a conformance profile which identifies the mandatory attributes for API operation. Once the document has been reviewed and approved by the API Project Team and Chief API Architect it will be published and added to the Open API Table - Preview.

Open API Directory - Preview

Example API Conformance Guide

Create and publish the API conformance profile

Publication of the Conformance Profile triggers the next stage of the API development process, where TM Forum’s Software Development Team generates the Reference/Sample Implementation, Conformance Test Kit, and Postman Collection. Once these have been completed and approved, links to the full set of six API assets are moved to the main Open API Directory and available to all.

Open API Directory

How do I specify and submit a proposal for a new API or API Suite?

Related Links