Open APIs

Expand all | Collapse all

Business Identifier (mapping between OpenAPI and Frameworx)

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

    Posted Oct 29, 2020 05:25
    Edited by Dan d'Albuquerque 27 days ago
    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 27 days ago

    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)

    TM Forum Member
    Posted 22 days ago
    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
    ------------------------------



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

    TM Forum Member
    Posted 22 days ago
    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.
    ------------------------------



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

    TM Forum Member
    Posted 20 days ago
    Edited by Jonathan Goldberg 20 days ago
    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.
    ------------------------------



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

    TM Forum Member
    Posted 20 days ago
    Thank you @Jonathan Goldberg for the kind update.

    Best regards,​​

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