Open APIs

 View Only
  • 1.  TMF 680 API v4.0.0 API Specification and Conformance Profile

    TM Forum Member
    Posted Jan 10, 2020 09:26
    Hi Members,

    It appears that v4.0.0 of TMF 680 Recommendation API is not yet posted , where can I find the API specification and conformance profile of the same ?
    The below link seems to have old version 2.0 of the API.

    https://projects.tmforum.org/wiki/display/API/Open+API+Table

    I could find 4.0.0 swagger in GitHub repo and can see much changes in it, but could not locate supporting documentation.

    A question in this context, the 2.0 specification does not seem to allow to retrieve recommendation with respect to a product offering alone (subscriber context may not be present). Is this something that has been updated in 4.0.0 specifications ?

    ------------------------------
    Indranil RoyChowdhury
    Ericsson Inc.
    ------------------------------


  • 2.  RE: TMF 680 API v4.0.0 API Specification and Conformance Profile

    TM Forum Member
    Posted Jan 13, 2020 01:59
    Hi Indranil
    Indeed the swagger has been published at https://github.com/tmforum-apis/TMF680_Recommendation - however the supporting materials are still being worked on.
    The Open API team leads have decided to take an agile approach to publishing, releasing materials following internal team review as they become ready, rather than waiting for all the assets to be finished.
    @Gregoire Laurent - the lead for the Recommendation API - may be able to give more clarity on when the supporting assets are likely to be ready.
    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.
    ------------------------------



  • 3.  RE: TMF 680 API v4.0.0 API Specification and Conformance Profile
    Best Answer

    TM Forum Member
    Posted Jan 13, 2020 04:39

    Hello Indranil and Jonathan,

     

    As Jonathan said, the specification document is still in TMF internal process. It will be published soon…

     

    Concerning your question  "A question in this context, the 2.0 specification does not seem to allow to retrieve recommendation with respect to a product offering alone (subscriber context may not be present). Is this something that has been updated in 4.0.0 specifications ?" :

    In this upcoming version, you still need the commercial context to perform this request. The expected inputs for the request could either be a category (which can regroup productOfferings), productOrder (or just a specific item of a productOrder) and/or a shoppingCart (or just a specific item of a shoppingCart). This information can be completed with a place and /or a channel.

    However, your suggestion is very interesting and led me to create a jira to improve the resource.



    ------------------------------
    Gregoire Laurent
    Orange
    My answer are my own & don't represent necessarily my company or the TMF.
    ------------------------------



  • 4.  RE: TMF 680 API v4.0.0 API Specification and Conformance Profile

    TM Forum Member
    Posted Jan 13, 2020 09:21
    Thank you @Gregoire Laurent & @Jonathan Goldberg for your prompt inputs. For the time being I have resorted to extension of the Recommendation schema v2 to have an additional product Context (ProductOffering type) attribute and have used CategoryRef to distinguish between different Recommendation flavors.

    Will definitely review the new specification when its published officially.


    ​​​

    ------------------------------
    Indranil RoyChowdhury
    Ericsson Inc.
    ------------------------------