Open APIs

 View Only
  • 1.  Common Resource model, similar to the SID

    TM Forum Member
    Posted Feb 10, 2022 11:20
    Dear colleagues,
    Working as an API architect, I have a need to see the common API resources data model combined from all our API domains. And this model is needed in a format that can be imported into a CASE solution (SPARX EA, Rational SA, etc.) in order to organize a supervisory control over the correctness of resource usage. As an example, such an XMI format file is available for the SID model.

    And I wonder if the respected community already has such a model? I hardly believe, that all the changes in the API data model are tracked manually, due to the complexity of the model.
    I'll be very pleased to get a link to download it.

    Thank you in advance.

    ------------------------------
    Petr Kolotushkin
    Netcracker Technology
    ------------------------------


  • 2.  RE: Common Resource model, similar to the SID

    TM Forum Member
    Posted Feb 10, 2022 12:25
    Hi Petr
    There is indeed a centralized model for the Open API entities (JSON-schema-based). This model is used in the generation of the Open API assets (swagger, user guide, etc.).
    Currently the model is not explicitly published, although it could be inferred from the published swagger files.
    I believe that there are plans to publish (eventually), but I am not privy to the planning.

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



  • 3.  RE: Common Resource model, similar to the SID

    TM Forum Member
    Posted Feb 11, 2022 02:16
    Hi Jonathan,
    Thank you for such a quick reply.

    > I believe that there are plans to publish (eventually), but I am not privy to the planning.
    I think it may be very useful to get this model published for the whole community. The additional value of it - is the ability to make a top-level view for the cross-domain links in order to see the discrepancies and hidden usage.
    I will look forward to seeing it someday. Hope that the people in charge of planning are also watching this conversation.


    ------------------------------
    Petr Kolotushkin
    Netcracker Technology
    ------------------------------



  • 4.  RE: Common Resource model, similar to the SID

    Posted Feb 14, 2022 01:49
    I'm not 100% sure, but for me it looks like the datamodel is available as json schema here https://github.com/tmforum-apis/Open_Api_And_Data_Model/tree/master/schemas.
    At least I use these resources to explore the API's and the datamodel.

    There is also this webpage: http://datamodel.tmforum.org/en/latest/. But here I have no clue how up to date the content is.

    ------------------------------
    Florian Kammermann
    Swisscom AG
    ------------------------------



  • 5.  RE: Common Resource model, similar to the SID

    TM Forum Member
    Posted Feb 14, 2022 02:12
    Florian, you've sent real useful links. Thank you a lot.
    Someone has made a big deal to combine all the available schemes in one place.

    Colleagues, is there a possibility to check the actual status of these links and, if they are actual, create a topic "useful links" somewhere here: https://projects.tmforum.org/wiki/display/API/TM+Forum+Ecosystem+API+Portal or even here: https://projects.tmforum.org/wiki/display/API/Open+API+Table to give all the TMF members the common API information in one place?​

    ------------------------------
    Petr Kolotushkin
    Netcracker Technology
    ------------------------------



  • 6.  RE: Common Resource model, similar to the SID

    TM Forum Member
    Posted Feb 14, 2022 02:34
    Hi
    The best person to answer regarding the currentness of the links would be @Henrique Rodrigues. In the GitHub link that you sent you will notice that the schemas folder was last updated 9 months ago.

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



  • 7.  RE: Common Resource model, similar to the SID

    TM Forum Member
    Posted 18 days ago
    Dear colleagues,
    I'm returning back with this question, @Henrique Rodrigues - may I ask you to share the current TMF API Json-schema definitions, please?

    According the schemas, published ​in GitHub (above), I've found one strange point: references between schemas are having uncommon notation.
    E.g., https://github.com/tmforum-apis/Open_Api_And_Data_Model/blob/v4.0/schemas/Product/Product.schema.json
    "$ref": "../EngagedParty/AgreementItemRef.schema.json#AgreementItemRef"​

    I'm wondering, why this link doesn't use JSON pointer, but calls the AgreementItemRef object directly.
    The expected behavior would be:

    "$ref": "../EngagedParty/AgreementItemRef.schema.json#/definitions/AgreementItemRef"

    Henrique Rodrigues, @Jonathan Goldberg, you have the same descriptions in your JSON-schemas?

    ​​

    ------------------------------
    Petr Kolotushkin
    Netcracker Technology
    ------------------------------