Open APIs

 View Only

  • 1.  Additional Attributes for Open APIs

    TM Forum Member
    Posted Mar 24, 2017 01:53

    Hi,

    We are currently developing Open APIs. A question popuped. Can we have additional optional attributes for Open APIs other than those stated in the API specification?

    Thanks in advance.

    Best regards.



    ------------------------------
    Serafettin Acir
    Etiya Information Technologies
    ------------------------------


  • 2.  RE: Additional Attributes for Open APIs

    Posted Mar 24, 2017 10:51
    Hi Serafettin!

    I'm facing the same kind of issue here. My dilema resides in Customer Management API. We need to identify our customer by an ID provided by Government (like social security number), any citizen can have a unique number. I tried to put this number in Characteristics attribute (map structure) but it will let the things a little complicated. I'm more comfortable denormalizing this attribute, letting it nested directly below Customer. In my case this attribute is mandatory. For optional ones, I just store as Characteristics.

    Best,


    ------------------------------
    Rafael Stirling
    Oi
    ------------------------------

    Original Message


  • 3.  RE: Additional Attributes for Open APIs

    TM Forum Member
    Posted Mar 24, 2017 12:48
    Hi Serafettin
    Yes you can have additional optional attributes as along as they have a different meaning to the predefined attributes. 

    Joann

    ------------------------------
    Joann O'Brien
    TM Forum
    ------------------------------

    Original Message


  • 4.  RE: Additional Attributes for Open APIs

    TM Forum Member
    Posted Mar 28, 2017 04:48
    Hi,

    Thanks for your responses. So according to Joann's reply, we understand that we can add an optional attribute to an API. This seems sensible, when we think of TMF Open API compliance. What if the attribute we want to add is mandatory? Rafael's scenario is a good example for this. Can we still add mandotary attributes directly to APIs?This seems to break our API's compliance.

    I haven't seen any related information in current API documents. We should clarify what will be our approach for extending Open APIs and put it on our TMF Open API documentation. Otherwise each new Open API adopters will struggle.

    Best regards.

    ------------------------------
    Serafettin Acir
    Etiya Information Technologies
    ------------------------------

    Original Message