Open APIs

Ha All,

I expect that this story is really a common one, but I didn't manage to find a proper topic. There is a resource API according to TMF639 with sub-resources place and relatedParty. And there are some external non-TMF APIs (cadastral info, manufacturer etc.) that we'd like to refer in these sub-resources. What should be a @referredType in these cases? I consider additionally relatedEntity pattern as an option for this, but I don't like this, since the nature of these objects is clear and they are definitely variants of place and party, we just do not have a clear referredType, since these APIs do not provide something like this in their schemas.

P.S. Of course it would be nice if these APIs just provide new compatible schemas, but it's not possible, at least in a short term.

------------------------------
Anna Berdnikova
Deutsche Telekom AG
------------------------------

Hi Anna

In the current TMF Open API model and design guidelines, sub-resources are not directly accessible.

At least in principle, you could synthesize a direct-access endpoint for those array sub-resources that have a locally unique ID/index/name, e.g. GET resource/1344555533/characteristic/bandwidth (to retrieve the characteristic named bandwidth for resource with id 1344555533).

But for sub-resources that are themselves references, and especially those that are polymorphic (like relatedParty or place) it is not so clear what the endpoint would look like.

Perhaps you can come up with a proposal?

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