Open APIs

Expand all | Collapse all

Attribute use in Open API

  • 1.  Attribute use in Open API

    TM Forum Member
    Posted Jun 16, 2020 03:38
    Hi All,

    I am working on a few open API's of TM forum for certification.

    All mandatory conditions have been fulfilled for Tm forum API and test results achieved with zero errors. But I need to work on some non-mandatory fields like @referredType,@baseType,@schemaLocation.

    Please suggest me how can I implement the above attributes in my API.

    Thanks in Advance.




    ------------------------------
    Akansha Agarwal
    Comviva
    ------------------------------


  • 2.  RE: Attribute use in Open API

    TM Forum Member
    Posted Jun 16, 2020 06:30
    Hi Akansha

    Not sure that I understand the nature of your query. I guess you have implemented some APIs and run the conformance test kits on those (which APIs, out of interest?).
    But are you asking what the semantic meaning of these @ attributes are, or how to manage persistent storage, or what?

    The Design Guidelines TMF630 give an extensive discussion of these attributes, I suggest you take a look at the re-published guidelines (still in beta approval stage) here.

    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: Attribute use in Open API

    TM Forum Member
    Posted Jun 16, 2020 07:18
    Hi Jonathan,

    Thanks for your prompt response.

    I have implement 3 API's Trouble ticket, Account Management, and Customer Management and in all these three APIs these attributes were not mandatory for the API operations.

    So I tested these APIs in CTK which given 0 failures.

    I just need to confirm apart from mandatory things required for Tm forum Compliance, is it necessary to implement all the attributes and guidelines.

    Apologies if my question doesn't make sense :)

    Regards

    ------------------------------
    Akansha Agarwal
    Comviva
    ------------------------------



  • 4.  RE: Attribute use in Open API

    TM Forum Member
    Posted Jun 17, 2020 06:54
    Hi Akansha
    From a formal perspective, I guess that if you passed the conformance test kit you are on the way to getting conformance.
    But I would suggest that if you are investing time and effort in building implementation for Open APIs you take a look at the business value that you are offering.
    The conformance test kit does not (currently) test the events raised as part of API implementation, and yet events can be an important part of a distributed software system.
    Similarly the formal definition of mandatory and optional attributes in most of the APIs allows creation of very lightweight entities, but the business may depend on attributes that are defined as optional.
    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.
    ------------------------------