Open APIs

 View Only
  • 1.  Support Required- TMF622 Create Product Order enhanced version compliance or certification

    TM Forum Member
    Posted Jan 20, 2020 01:33
    Edited by Sameer Uppal Jan 28, 2020 00:15
    Hi Team,

    We are working on TMF622 Create Product Order. As part of creating Product Order, we have realized to add some additional attributes and additional hierarchy/tags into existing TMF622 as part of the business requirements. As part of this process, we have enhanced the TMF622 API. The customer is asking to get TMF622 certification\compliance for the enhanced version.

    Can you guide us, how we can validate enhanced TMF622 API? Please share the process or guideline which we can follow or take care of while adding additional attributes and tags.  We got some guidelines related to Open APIs CTK specification(s) and tried running our script but not getting a clear picture. 

    Appreciate your support if someone has validated their API guideline and how additional attributes and tags can be added into TMF622 API and it is as per TM Forum guidelines.  


    Thanks in advance for your support and guidance. Please let us know if you need additional information. We can have a shortcalls if required. 

    Waiting for your input.

    ------------------------------
    Thanks & Regards
    Sameer Uppal
    +91-9958199197
    ------------------------------


  • 2.  RE: Support Required- TMF622 Create Product Order enhanced version compliance or certification

    TM Forum Member
    Posted Jan 22, 2020 08:28
    Hi Sameer
    Probably best to reach out to @Henrique Rodrigues - he maintains the CTKs and perhaps he can assist in explaining how to verify your implementation against the CTK for this API.
    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: Support Required- TMF622 Create Product Order enhanced version compliance or certification

    TM Forum Member
    Posted Jan 22, 2020 22:30
    thanks, lot Jonath for input

    HI Henrique Rodrigues,

    Can you guide me here?

    Thanks & Regards
    Sameer Uppal

    ------------------------------
    Sameer Uppal
    ------------------------------



  • 4.  RE: Support Required- TMF622 Create Product Order enhanced version compliance or certification

    TM Forum Member
    Posted Jan 28, 2020 00:28
    Hi Team,

    Waiting for your input. Kindly help me, how Open APIs CTK Specification is working and validating enhanced TMF622 API. 

    Your support will be appreciated. Seeking your help.

     Thanks & Regards
    Sameer Uppal

    ​​​​

    ------------------------------
    Thanks & Regards
    Sameer Uppal
    ------------------------------



  • 5.  RE: Support Required- TMF622 Create Product Order enhanced version compliance or certification
    Best Answer

    TM Forum Member
    Posted Jan 29, 2020 06:23
    Hi Sameer,

    I would say that in summary - as long as your extension maintains the contract of the TMF-defined interaction (lets call it the 'super-class'), then it will pass the TMF-CTK.

    The CTK is a Postman script that will exercise all aspects of the API as defined by the TMF reference, and make assertions about the responses that it receives. For example: As long as your implementation accepts/produces the mandatory/'required' attributes and relationships as defined in the TMF-Swagger file, then it (the CTK) will not care that you have added additional attributes/relationships or lifecycle-states to your 'sub-class'.

    However if you have added your own mandatory/'required' attributes/relationships to your 'subclass' - then that breaks the TMF-defined contract and the CTK would fail (as your implementation would presumably reply to a CTK POST of a 'vanilla' TMF payload with a 4xx response). I would suggest - as a mental exercise that you read through your extended swagger and consider if the original TMF-defined interactions would still be valid (ie: can you POST/GET/PATCH/DELETE with a standard,  unextended payload).

    Also, if you have added new paths and definitions - as long as they are optional - the TMF-CTK would not see or test them.

    Hope this helps!

    ------------------------------
    Stephen Harrop
    Principal Enterprise Architect
    Vodafone Group
    ------------------------------



  • 6.  RE: Support Required- TMF622 Create Product Order enhanced version compliance or certification

    TM Forum Member
    Posted Jan 29, 2020 08:49
    thanks lot @Stephan Haroop for your input.

    We will check and come back if we need additional help.

    ------------------------------
    Thanks & Regards
    Sameer Uppal
    ------------------------------