Open APIs

 View Only

  • 1.  TMF654_Prepay_Balance typo problem found

    Posted Dec 17, 2019 08:45

    Dear TM forum!

      Me and my colleague found a significant typo in TMF654_Prepay_Balance.swagger.json file, while we were using it. More precisely, when we wanted to generate the necessary endpoint, namely /balancetopup - which gives back a BalanceTopupRequest object if the response was successful, we realized that the swagger code generator didn't generate all the properties of BalanceTopupRequest.
      We realized, that the problem as you can see in the attached document was, that the allOf array didn't include the properties of BalanceTopupRequest, only a "$ref": "#/definitions/BalanceTopupBody", thus only the properties of the BalanceTopupBody were generated. Our solution as you can see on the attached file was the following: we corrected the brackets in order to "allOf" include the properties of BalanceTopupRequest as well and we also define the type: object.

    This problem exist in the whole TMF654_Prepay_Balance.swagger.json file, so we corrected all of them.

    P.S - For some reason I can't attach not a png file nor a txt file to present the problem and the solution.



    ------------------------------
    Dániel Megyaszai
    Vodafone GmbH
    ------------------------------


  • 2.  RE: TMF654_Prepay_Balance typo problem found

    Posted Dec 17, 2019 11:04
    Hi Dániel

    TMF654 is being refreshed to update to new design guidelines, functionality, etc.. Unfortunately no commitment can be given at this time if and when the update will be published.
    Adding @Kevin King, who is the lead for ​this API, so that he will be aware of the issue.

    Also adding @Alan Pope - so that we can perhaps consider an emergency fix of the published materials.

    As a general comment, I will say that the Open API team has been moving away from hand-crafted swagger files to tool-based swagger generation from our json schema files. It is likely that the type of error you encountered will not happen in the future, thanks to this process improvement.

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



Related Content