Open APIs

 View Only

  • 1.  Making TMF Optional OpenApi attribute required

    Posted Oct 01, 2024 08:56

    Hello, 
    I'm part of development team that maintain existing telecom subsystem and we are completely new to TMForum, and we are interested in implementing TMF632 Party Management Api V5.0.0 in the system. But we are facing a case where the telecom vendor is forced by legal authorities in its country to hold a specific data for each party that we found in TMF632 schema attributes but its marked as optional (for example: Individual Party model should have at least one Individual Identification of any type).

    To pass this we made a validation that will make Apis fail unless these fields are provided which practically make the fields from "optional" to "required". Now we are fearing that doing such thing will make our implementation break TMF conformance.

    By quick research I found that CTK contains a CHANGEME.json file that allow us to modify payloads thus, assumed that we can add the attributes we made as required when we are trying to get the certification. I hope to validate this assumption.
    Thanks,



    ------------------------------
    Hussein Anabtawi
    Software Engineer @ Leading Point
    ------------------------------


  • 2.  RE: Making TMF Optional OpenApi attribute required

    Posted Oct 07, 2024 10:33

    you can read the the conformance requirement guide in the API table.

    Many countries/regions have local requirements, if you wish to add new attributes and make them required, that's entirely up to you and how you define your API contract.



    ------------------------------
    Kind regards,

    Matthieu Hattab
    Lyse Platform
    ------------------------------



  • 3.  RE: Making TMF Optional OpenApi attribute required

    Posted Oct 08, 2024 10:22

    Thanks Matthieu Hattab,

    Let me provide a use case: in Party Management API (TMF 632), "POST /individual" which used to creates an Individual; the mandatory fields are "givenName" and "familyName" only, but in some countries, you cannot create a party without identity (individualIdentification.identificationType and individualIdentification.identificationId)

    So in this case you have to make the individualIdentification.identificationType and individualIdentification.identificationId mandatory attributes!

    The concern is: if this change of making optional fields as mandatory will cause a CTK failure or not?



    ------------------------------
    Mohammad Obeidat
    Leading Point
    ------------------------------

    Original Message


  • 4.  RE: Making TMF Optional OpenApi attribute required

    Posted Oct 09, 2024 03:35
    Edited by Matthieu Hattab Oct 09, 2024 05:37

    The conformance requirement guide tells what is mandatory at resource or attribute level. That's the only requirement to pass the conformance.

    any element that is optional will not be tested, so if you make one element mandatory, it does't concern conformance.

    also, if you add resource/attributes, they will not be tested.



    ------------------------------
    Kind regards,

    Matthieu Hattab
    Lyse Platform
    ------------------------------

    Original Message


  • 5.  RE: Making TMF Optional OpenApi attribute required

    Posted Oct 09, 2024 07:02

    That's great, thanks Matthieu.



    ------------------------------
    Mohammad Obeidat
    Leading Point
    ------------------------------

    Original Message


Related Content