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

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.

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

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.

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

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

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 Table - Early Adoption (Beta). A link to the Open API table itself and an example user guide can be found below.

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 - Early Adoption (Beta). A link to the Open API table itself and an example conformance profile can be found below.

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 Table and available to all.