Open APIs

Expand all | Collapse all

Domain model

  • 1.  Domain model

    TM Forum Member
    Posted Feb 05, 2019 02:12
    Hi Everyone,

    I am doing an exercise to map/convert an existing API (Customer Management) to Open API. However I realize after looking at the customer management specs that I first need to understand the open API entity model and its fields.

    What is the best place to start in order to understand the API's? Is there any place where I can find the entity model and its description.

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

    Thank you
    Suman Bagde

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


  • 2.  RE: Domain model

    TM Forum Member
    Posted Feb 07, 2019 05:56
    Hi Suman
    Each of the published APIs includes a specification document showing UML diagrams of the data model relating to the API, and a list of attributes/relations with descriptions. See https://projects.tmforum.org/wiki/display/API/Open+API+Table for a full list of the APIs and the downloadable spec documents.
    As distinct from the SID, there is no consolidated downloadable model for the full API. In any case we are currently moving towards a schema-driven approach, where the underlying data model will be mastered in JSON schema files. This has started in r18.5 and will continue in r19.0, but I don't know if the transformation will be complete in r19.0.
    Hope it helps

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    ------------------------------



  • 3.  RE: Domain model

    TM Forum Member
    Posted Feb 07, 2019 06:29
    Hi Jonathan,

    Thank you very much for the response. I am trying to go through the individual API's and piece things together :)

    Apart from the JSON examples given in the specs, are there any real world telco sample JSON's available on the TMF forum?

    ------------------------------
    Kind Regards,
    Suman
    ------------------------------



  • 4.  RE: Domain model

    TM Forum Member
    Posted Feb 07, 2019 09:05
    I am not aware of real-world samples, but this does not mean that there are none, just that I don't know if they are.
    A close approximation might be the component suites. We already have one published suite, TMF910 for self-care, see the documents here including a set of consistent JSON messages. Another one is in preparation TMF909 for Network-as-a-Service, also there the examples should be consistent. I don't know what the expected publication schedule is for this NaaS suite.

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    ------------------------------



  • 5.  RE: Domain model

    TM Forum Member
    Posted Feb 08, 2019 05:52
    Suman
    First recommendation is that some of what you are seeking is in active discussion in  the API team and also the ODA Production Team on Connectivity Service models using 5G as an example. Joining those teams and following/ contributing to that work would be the best approach.

    This isn't a complete answer as this is work in progress but well advanced   For resource management and virtualization we developed out of the ZOOM (now ODA Production)  /API teams  an OPEN API TMF 644 Resource Function Activation and configuration. In that document it shows the general mapping of NFV entities to the resource model based on SID  Resource Functions .  The requirements for this API were derived from work in TR255:

    https://www.tmforum.org/resources/exploratory-report/tr255-resource-function-activation-and-configuration-suite-r17-5-0/

    Parts A and B look at how to model example telco services in SID e.g. VCDN and there is a mapping from SID, and in part B some json example of a firewall in Section 7 .

    Currently  the mapping for each API are captured in the TMFxxxA part of the API. However there is an active API tam  discussion about changes to how these mapping are organised and you need to track the API team discussions for the latest position. Importantly there are  mapping rules in SID team GB990 API Data Model and Information Framework Mapping Guide Book R16.0.1.

    For Connectivity Services representation the SID and the ODA Production team is working on this topic in GB999 User Guide for Network Slice Management R18.5.0 and elated SID documents notably GB922 Logical and Compound Resource Computing and Software R18.0.1 And the Service Overview

    TR255 Part C addresses from a Tosca perspective a virtual  Firewall which looks firewall example form the TOSCA .
    Several of these concepts were tested in a catalyst called Real Virtuality which was run twice.

    Again best recommendation is to join and work with both the Open API and ODA Production teams as this is an active discussion topic.

    ------------------------------
    Dave Milham
    TM Forum Chief Architect, TM Forum
    ------------------------------