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

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

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

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

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