Open APIs

Expand all | Collapse all

How to get a detailed History of API/Attribute level changes between two versions of Open API Spec

  • 1.  How to get a detailed History of API/Attribute level changes between two versions of Open API Spec

    Posted Mar 29, 2021 10:15
    Hello Experts,
    Can you tell me how to find the detailed list of changes at a parameter level between two versions of Open API ? I see the TMF666_Account_Management_API_REST_Specification_R19.0.0.pdf has a version history, but it looks at higher conceptual level. Is there a document that explains, addition/deletion/modification of APIs, Operations, Parameters ?

    For example:
    TMF666-Account-v4.0.0.swagger.json
    vs
    TM666-Account-v2.0.0.swagger.json

    Should i do a swagger diff and find out on my own ? Because that sounds a bit odd, because TMF level of maturity, there should be some document explaining the low level changes between versions.



    ------------------------------
    Vinoth Somasundaram
    Vinoth Kumar S
    ------------------------------


  • 2.  RE: How to get a detailed History of API/Attribute level changes between two versions of Open API Spec

    TM Forum Member
    Posted Apr 05, 2021 03:40
    Hi Vinoth

    Unfortunately, we don't have such documentation at the moment in the Open API published materials. I think that you are right and we should aim to have such.
    It would be a great enhancement, perhaps you have a good swagger differencing tool that could help here?


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