Open APIs

Hi,

Due to certain constraints, the implementation of TMF 632 in done in such a way that, it connects to a back end that exposes the CRUD operations via HTTP interface. In such scenario, should the back end field restrictions related validations be handled at TMF layer or should it be delegated to the services that will be invoking the TMF service?

Also, there are certain fields which will be statically passed on to the backend from TMF layer-should the error from backend related to those fields be handled at TMF layer and transformed or the error message from back end be passed as is in the error response?


Thanks

------------------------------
Ramkumar M G
Torry Harris Integration Solutions
------------------------------

Hi Ramkumar
From TMF Open API perspective, an API specification is just that, a specification. There is no prescription on how to implement the API, you can write a COBOL monolith that exposes the APIs, or you can write dedicated microservices for each API, or whatever.
Your responsibility as an API implementer is to ensure that your implementation aligns with the specification (and conforms with the test kit, if you are seeking certification).
Specifically regarding error messages, the Open API does not prescribe specific error codes in the Error structure, beyond the HTTP return statuses.
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,

Thanks for the update.

------------------------------
Ramkumar M G
Torry Harris Integration Solutions
------------------------------

Original Message:
Sent: Jun 02, 2021 01:46
From: Jonathan Goldberg
Subject: TMF 632 Error Management

Hi Ramkumar
From TMF Open API perspective, an API specification is just that, a specification. There is no prescription on how to implement the API, you can write a COBOL monolith that exposes the APIs, or you can write dedicated microservices for each API, or whatever.
Your responsibility as an API implementer is to ensure that your implementation aligns with the specification (and conforms with the test kit, if you are seeking certification).
Specifically regarding error messages, the Open API does not prescribe specific error codes in the Error structure, beyond the HTTP return statuses.
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.
------------------------------