Open APIs

 View Only

  • 1.  Urgent: Guidelines for using Camel Case or Lower Case for TMF API's

    Posted Jan 10, 2024 00:47
    Edited by Mahesh Choudhari Jan 10, 2024 01:10

    Dear Team,

    Need urgent input on any design guidelines or TMF compliance w.r.t keeping parameter naming convention as camel case or lower case etc. specifically for resourceCharacteristics or serviceCharacteristics etc. we need to list all parameters so it must be in camel case or lower case etc.

     {
              "name": "eqptIcgResiliencyGroup",
              "value": "A"
            },
            {
              "name": "networkRole",
              "value": "Core"
            },
            {
              "name": "notes",
              "value": ""
            },
           {
              "name": "network",
              "value": "GNV"
            }

    Kindly guide what is design guideline or TMF compliance w.r.t it. I can see in TMF 630 part 1 as parameters in URI must be camel case or lower case but did not find anything w.r.t API parameters under characteristics and all for passing information.

     



    ------------------------------
    Mahesh Choudhari
    BT Group plc
    ------------------------------



  • 2.  RE: Urgent: Guidelines for using Camel Case or Lower Case for TMF API's

    Posted Jan 10, 2024 04:50

    As far as I am aware, there is no guidance in TMF assets regarding how to name characteristics. Bear in mind that characteristic names, especially in product (BSS) layer, are likely to be displayable to end customers.

    Disregarding for the moment the issue of support for multiple national languages, this would indicate that names should be "friendly", avoiding complex acronyms, including spaces, and initial capitalization, such as Network Role, Notes, etc.

    If, however, you devolve all displayable strings, including catalog strings, to a content management system, the characteristic names become more like software elements, and you might want to adopt the conventions for attribute/property names.

    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: Urgent: Guidelines for using Camel Case or Lower Case for TMF API's

    Posted Jan 11, 2024 06:51

    Bear in mind that characteristic names, especially in product (BSS) layer, are likely to be displayable to end customers.

    just adding my classic rant about customer-facing data and content:

    the API should not be opiniated in what (and how) data and content is displayed in engagement management.
    Ressource and Attributes in the TMF API  should be worded as suggested by TM Forum (or the SID) and "translated" in a customer-friendly manner in a CMS.
    that "translation" can be context aware (sales channel, customer preferred language, country, business entity exposed (catalogue, shoppping cart, invoice...).

    My 2 cents.



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

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

    Original Message


Related Content