Open APIs

 View Only
  • 1.  Where can I get the latest version of Open APIs (swaggers and schemas package)?

    Posted Mar 23, 2021 14:11
    Dear TM Forum team,

    We are starting to move a subset of our current APIs to TM Forum - Open APIs standards.

    On GitHub repository Open_Api_And_Data_Model (https://github.com/tmforum-apis/Open_Api_And_Data_Model) tells me that the lasted version of APIs and schemas are available on a v4.0 branch, as descrived bellow:

    I cloned v4.0 branch and I can't find some APIs inside that branch (i.e: TMF668 - Partnership Type Management API).


    What is the best place to get the complete and up to date apis (swaggers and schemas package)?

    Best,
    Ricardo


    ------------------------------
    Ricardo Martins
    SKY Brasil an AT&T Inc Company
    ------------------------------


  • 2.  RE: Where can I get the latest version of Open APIs (swaggers and schemas package)?

    TM Forum Member
    Posted Mar 24, 2021 03:14
    Hi Ricardo
    Firstly, welcome to TM Forum Open APIs.
    Please note that it is not recommended to go directly to GitHub, since you are missing the status. It is always best to go to the Open API main table here:
    https://projects.tmforum.org/wiki/display/API/Open+API+Table

    This gives you access to all the published assets, including swagger files, user guides, and more. Additionally, you will see in the page tree a link to early access/beta, where you can get access to additional assets that are in the process of being published but not considered final yet.

    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: Where can I get the latest version of Open APIs (swaggers and schemas package)?

    TM Forum Member
    Posted Mar 24, 2021 11:53
    Hi Jonathan, I believe in the past there may have been some challenges with inconsistencies (and perhaps delays) between the Open API table and what versions were actually available and published for use.  Are those addressed now and we can fully rely on the Open API table for the latest up-to-date approved versions?

    I too have been using the github repos on a regular basis to pull the latest v4.0 swaggers (where available) for all the APIs.  I get the sense that may not be the best approach?

    Thanks,
    Kevin.

    ------------------------------
    Kevin Ng
    TELUS
    ------------------------------



  • 4.  RE: Where can I get the latest version of Open APIs (swaggers and schemas package)?

    TM Forum Member
    Posted Mar 25, 2021 05:50
    Hi Kevin
    I don't work for TM Forum, so I cannot give you an authoritative answer. I can say that the Open API team makes best effort to ensure accuracy of the Open API table (both the main table and the early access beta table), including the pointers to the corresponding swagger files in GitHub.
    Like I said, by going directly to GitHub you are not necessarily sure of the provenance and publication status of the assets.
    Perhaps @Alan Pope can give you more insights into the release and publication process.



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