Open APIs

Hi there!!
I am a newbie to this forum and wanted to understand the process of design and development of a new API and then publishing it to TMForum. Specifically looking for pointers related to :
1.  Review of Areas selected for new API design - if the review is needed and by whom should I get it reviewed.
2. Environment needs for design, development and testing of such APIs - is there an environment that can be used for such purposes
3. Process of getting API validated and reviewed, post successful testing by developer - details of the process
4. Publication of the API in TMForum
5. Any other relevant points, not covered in above.

Regards,
Sayantani Biswas

------------------------------
Sayantani Biswas

------------------------------

Hi Sayantani
I am sure that the program leads (@George Glass, @Andreas Polz, @Stephen Harrop, @Ludovic Robert, and ​​​​others) would be very happy to hear about your willingness to contribute.
The first step would be to discuss​​ with them which APIs are missing and where your domain knowledge could best assist.

The Open API project is all about design of APIs - we have a set of tools that assist in the design of the schema, spec document, and swagger file. Part of the API design is also the creation of a conformance profile document, and later on also a testing kit that validates an conforming implementation of the API. @Henrique Rodrigues could explain in more detail how the testing kit is created for the API.​
We have a peer review process, in which team members review API designs, and approval by the program's chief architect @Pierre Gauthier - following this there is a formal publication procedure that is common to all TMF publications.
Note that there are no specific tools for development of an API implementation (nor any prescribed development environment or language), you would use whatever procedures you feel relevant to create an implementation. And there is no need to create an API implementation as part of the design process.

Hope it helps.

​

------------------------------
Jonathan Goldberg
Amdocs Management Limited
Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
------------------------------

Hi Jonathan,

Thank you for your reply. I will send a mail to the Program Leads and continue the discussion.

------------------------------
Sayantani Biswas
Accenture
------------------------------

Original Message:
Sent: Oct 22, 2019 05:49
From: Jonathan Goldberg
Subject: New API Design and contribution

Hi Sayantani
I am sure that the program leads (@George Glass, @Andreas Polz, @Stephen Harrop, @Ludovic Robert, and ​​​​others) would be very happy to hear about your willingness to contribute.
The first step would be to discuss​​ with them which APIs are missing and where your domain knowledge could best assist.

The Open API project is all about design of APIs - we have a set of tools that assist in the design of the schema, spec document, and swagger file. Part of the API design is also the creation of a conformance profile document, and later on also a testing kit that validates an conforming implementation of the API. @Henrique Rodrigues could explain in more detail how the testing kit is created for the API.​
We have a peer review process, in which team members review API designs, and approval by the program's chief architect @Pierre Gauthier - following this there is a formal publication procedure that is common to all TMF publications.
Note that there are no specific tools for development of an API implementation (nor any prescribed development environment or language), you would use whatever procedures you feel relevant to create an implementation. And there is no need to create an API implementation as part of the design process.

Hope it helps.

​

------------------------------
Jonathan Goldberg
Amdocs Management Limited
Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
------------------------------