Open APIs

Expand all | Collapse all

Changes between releases

  • 1.  Changes between releases

    TM Forum Member
    Posted Jun 02, 2020 11:11
    Hi all,

    Pretty basic question, apologies if this had already been asked.
    How can I find the changes for a specific api between releases. For example, between the latest version and N-1.

    Thank you
    Gil

    ------------------------------
    Gil Steiner
    Product Manager, Vlocity
    ------------------------------


  • 2.  RE: Changes between releases

    TM Forum Member
    Posted Jun 03, 2020 00:44
    Hi Gil
    It's a very good question, no need to apologize.
    I personally think that we (the Open API team) still have work to do here, we should (for example) consider having a release notes section in the user guide (what we used to call the spec), and ensure that we maintain it from version to version.

    In the absence of ​such, you could do a semantic compare between the swagger files from the different versions (a text compare would not be enough since things might have been moved around) - I don't know if such tools exist, but try this: https://swagger.io/blog/api-development/using-swagger-to-detect-breaking-api-changes/

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