Open APIs

 View Only

  • 1.  Business Identifier (mapping between OpenAPI and Frameworx)

    Posted Oct 29, 2020 05:25
    Edited by Dan d'Albuquerque Nov 04, 2020 04:27
    Hi All

    I am trying to understand the mapping between the 'id' field within the OpenAPIs for the concrete entities and the 'ID' (business identifier) attribute within the SID model and physical data model.  According to the OpenAPI design guidelines part 1 there is no mapping between the two.  Hence how do you determine the business identifier?

    The TMF630_REST_API_Design_Guidelines_Part_1_v4.0 states that the resource identifier (id) is not the Business Identifier (ID from SID) as follows:
    Would it be possible to correct this specification to state that the resource identifier IS the business identifier?

    Also, in the various OAS for Product/Service/Resource catalogs, a version field has been added to the OpenAPI to indicate entity version management for the lifecycle management.  However, the POST operation definition does not allow the 'id' field to be supplied when creating new entity versions of the resources.  Is this a mistake?

    Thanks
    Dan.

    ------------------------------
    Dan d'Albuquerque
    TO BE VERIFIED
    ------------------------------


  • 2.  RE: Business Identifier (mapping between OpenAPI and Frameworx)

    Posted Nov 04, 2020 04:29

    Hi All
    Does anyone know whether a CR has already been submitted for this?

    Thanks



    ------------------------------
    Dan d'Albuquerque
    TO BE VERIFIED
    ------------------------------



  • 3.  RE: Business Identifier (mapping between OpenAPI and Frameworx)

    Posted Nov 09, 2020 07:59
    I am also trying to understand this. Could some one please help.

    @Adrienne Walcott​, @Jonathan Goldberg could you please throw some light.​

    Best Regards,

    ------------------------------
    Kalpana HV
    Colt Technology Services
    ------------------------------

    Original Message


  • 4.  RE: Business Identifier (mapping between OpenAPI and Frameworx)

    Posted Nov 10, 2020 01:16
    Hi Dan
    Regarding the ID, I think that the guideline text needs to be fixed, I have submitted a JIRA issue for this.
    Regarding POST of versioned entity, this is indeed an unfortunate defect in our generated swaggers, also for this I have submitted a JIRA issue.
    Thanks for your alertness

    ------------------------------
    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.
    ------------------------------

    Original Message


  • 5.  RE: Business Identifier (mapping between OpenAPI and Frameworx)

    Posted Nov 11, 2020 10:36
    Edited by Jonathan Goldberg Nov 11, 2020 10:36
    Just to keep the public updated, we discussed both issues in our API governance meeting:
    • Regarding the ID - a cosmetic change will be suggested for the guideline. But note that in general using a "business" identifier (whatever that means) could be problematic, if this ID is subject to change. See another recent post here on this topic.
    • Regarding the versioned entity, we agreed that it is a problem and we need to find some way to fix it for now and going forward. In the meantime as a workaround you could manually edit the relevant swagger file to add the ID into the xxxx_Create resource - this is indeed probably the short-term fix that we are considering to make.


    ------------------------------
    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.
    ------------------------------

    Original Message


  • 6.  RE: Business Identifier (mapping between OpenAPI and Frameworx)

    Posted Nov 12, 2020 00:00
    Thank you @Jonathan Goldberg for the kind update.

    Best regards,​​

    ------------------------------
    Kalpana HV
    Colt Technology Services
    ------------------------------

    Original Message


  • 7.  RE: Business Identifier (mapping between OpenAPI and Frameworx)

    Posted Apr 21, 2024 21:44

    Hi @Jonathan Goldberg, 

    Sorry to bring up this old post. 

    just wonder if MSISDN is consider as business identifier? 

    Understand the concern is the value might be change in the future, but for resource inventory API (TMF639), MSISDN is unique within the inventory, assume it won't be change. 

    By using the MSISDN as ID would that cos the API become not conformance ? 

    Thanks. 



    ------------------------------
    Chio Chuan Ooi
    SingTel Optus
    ------------------------------

    Original Message


Related Content