Open APIs

Expand all | Collapse all

Input parameters for API's

  • 1.  Input parameters for API's

    TM Forum Member
    Posted Mar 15, 2019 05:08
    Hi All,

    Some of the input parameters in the API operations are defined as integer.

    Examples: limit, offset

    Do they necessarily have to be integer's or can we change them to string in our implementation? Would we still be complaint?

    Thank you.

    ------------------------------
    Warm Regards,
    Suman Bagde

    ------------------------------


  • 2.  RE: Input parameters for API's

    TM Forum Member
    Posted Mar 17, 2019 20:53
    From a formal perspective, @Henrique Rodrigues can hopefully give you an answer regarding the behavior of the conformance kits.
    But I am wondering why you would want to change the type - these fields have integer semantics and it is not clear (to me) what you would gain by making them strings.​

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    ------------------------------



  • 3.  RE: Input parameters for API's

    TM Forum Member
    Posted Mar 18, 2019 05:22
    Hello @Suman Bagde​.

    On the CTK (Conformance Test Kit) the Mandatory parameters will be tested by the variable type. The optional parameters will not. Meaning: if you change the type of an optional variable you can still be conformant.

    The limit and offset are not currently being used in any CTK, as mandatory or optional.

    We have plans to have more levels of Conformance, for compliance on those new levels you will need to have the optional parameters the right variable type when those optional parameters are present. To my knowledge there are no discussion on enforcing the variable type of such parameters as limit and offset.

    As @Jonathan Goldberg said, those fields being integer make sense by the expected data they will hold. If you think we are overlooking some possibilities let us know.

    Best Regards,

    Henrique Rodrigues


    ------------------------------
    Henrique Rodrigues
    TM Forum
    ------------------------------



  • 4.  RE: Input parameters for API's

    TM Forum Member
    Posted Mar 20, 2019 06:03
    Thank you for your inputs  @Henrique Rodrigues, @Jonathan Goldberg

    The reason we want to either change the parameter to string is because of internal implementation. Changing to integer will need changes at multiple places. 
    ​​​For now we will change the data type to string and proceed since it is not a conformance parameter.

    Thanks again.

    ------------------------------
    Regards,
    Suman Bagde

    ------------------------------