Open APIs

Hello,
I have a general question about the TMF OpenAPIs. I noticed with the TMF673 (Geographic Address Mgmt) that there is a GeographicAddressValidation resource, that is not part of the SID. The other resources in the API specs (like GeographicAddress and GeographicLocation) are always based on entities of the SID.

My question about this: What is the reason for doing this with the GeographicAddressValidation resource? Is the goal to map all OpenAPI resources also in the SID? Or did you deliberately exclude the GeographicAddressValidation resource because the resource is only relevant in the context of the API and is not used in any other framework (eTOM...)?

Many thanks in advance for any explanation.

Kind Regards,

Jan

------------------------------
Jan Lemmermann
EWE TEL GmbH
------------------------------

Hi Jan

A great question, which raises a number of important points about the Open API design paradigm.
As a rule, the Open API model is strongly based on the Information Framework (SID), but we have various rules that make the model more "friendly" for use as REST payloads.

With that, please note the following:

• The SID is a static logical information model. It does not reflect business operations in the way that the Open API does. Since there is a need to define business operations outside the CRUD (create/read/update/delete) entity paradigm, we have what we call a Task resource, which is a way of expressing semantics of a non-CRUD API operation. We have many examples in the API, including address validation, prepaid balance operations, qualification, and more. The task resource will typically not be found in the SID.
• Practically speaking, the Open API and the SID are moving forward with different cadences, thus it is possible that we will introduce real business entities (or make changes) into the Open API even before they appear in the SID.

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,I am wondering is there any sandbox environment so that I can play some features at TMF673? I tried some postman and Swaggers, sounds like none of them works. Thanks

------------------------------
Richard Liu
Bell Canada
------------------------------

Original Message:
Sent: Feb 22, 2020 13:44
From: Jonathan Goldberg
Subject: OpenAPI resources not part of SID?

Hi Jan

A great question, which raises a number of important points about the Open API design paradigm.
As a rule, the Open API model is strongly based on the Information Framework (SID), but we have various rules that make the model more "friendly" for use as REST payloads.

With that, please note the following:

• The SID is a static logical information model. It does not reflect business operations in the way that the Open API does. Since there is a need to define business operations outside the CRUD (create/read/update/delete) entity paradigm, we have what we call a Task resource, which is a way of expressing semantics of a non-CRUD API operation. We have many examples in the API, including address validation, prepaid balance operations, qualification, and more. The task resource will typically not be found in the SID.
• Practically speaking, the Open API and the SID are moving forward with different cadences, thus it is possible that we will introduce real business entities (or make changes) into the Open API even before they appear in the SID.

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

Perhaps @Henrique Rodrigues can assist here.​

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

Original Message:
Sent: Mar 09, 2020 12:27
From: Richard Liu
Subject: OpenAPI resources not part of SID?

Hi,I am wondering is there any sandbox environment so that I can play some features at TMF673? I tried some postman and Swaggers, sounds like none of them works. Thanks

------------------------------
Richard Liu
Bell Canada
------------------------------


Original Message:
Sent: Feb 22, 2020 13:44
From: Jonathan Goldberg
Subject: OpenAPI resources not part of SID?

Hi Jan

A great question, which raises a number of important points about the Open API design paradigm.
As a rule, the Open API model is strongly based on the Information Framework (SID), but we have various rules that make the model more "friendly" for use as REST payloads.

With that, please note the following:

• The SID is a static logical information model. It does not reflect business operations in the way that the Open API does. Since there is a need to define business operations outside the CRUD (create/read/update/delete) entity paradigm, we have what we call a Task resource, which is a way of expressing semantics of a non-CRUD API operation. We have many examples in the API, including address validation, prepaid balance operations, qualification, and more. The task resource will typically not be found in the SID.
• Practically speaking, the Open API and the SID are moving forward with different cadences, thus it is possible that we will introduce real business entities (or make changes) into the Open API even before they appear in the SID.

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.