Open APIs

 View Only
  • 1.  TMF637 Product Inventory Management API URL inconsistent

    TM Forum Member
    Posted 4 days ago
    Hello,

    I would like to have your feedback about an issue we have identified in TMF637 Product Inventory Management API documents

    According to the information present in the API User Guide /Specification PDF we have:

        GET serverRoot/tmf-api/productManagement/v4/product
        POST serverRoot/tmf-api/productManagement/v4/product
        DELETE serverRoot/tmf-api/productManagement/v4/product
        PATCH serverRoot/tmf-api/productManagement/v4/product/

    - Here we can see that url shows "tmf-api/productManagement"

    However in this same document we have an example for GET that shows:
    Request
        GET serverRoot/tmf-api/productManagement/v4/product/g265-tf85
    Response:
            200
            {
                "id": "g265-tf85",
                "href": "https://host:port/productInventoryManagement/v4/product/g265-tf85",
                "description": "product description"
            (...)
    - In this example the href url shows "tmf-api/productInventoryManagement".

    Additionally, if we check the TMF swagger or the Postman Collection we see:
        "url": "{{Product_Inventory_API}}/tmf-api/productInventory/v4/
    - Here we can see that url shows "tmf-api/productInventory"

    In summary we can see some inconsistency across the several sources.

    Which one shall be the correct one? The one present in the API User Guide / Specification PDF?

    Many thanks,
    Miguel Leal


    ------------------------------
    Miguel Leal
    Nokia
    ------------------------------


  • 2.  RE: TMF637 Product Inventory Management API URL inconsistent

    TM Forum Member
    Posted 3 days ago
    Hello Miguel,

    I have been through the same situation a few weeks ago, and I would like to highlight that retrieving product using its id is defined in swagger files.

    I suggest you use the swagger files for the API as a starting point, and then use the testing report to identify the missing operations, filtering or field choosing.

    use below link for reference for the Open API table:
    Open API Table - TM Forum Ecosystem API Portal - TM Forum Confluence

    Hope that helps.

    ------------------------------
    Ahmed Elbanna
    SEGMA COM
    ------------------------------



  • 3.  RE: TMF637 Product Inventory Management API URL inconsistent

    TM Forum Member
    Posted 2 days ago
    Edited by Miguel Leal 2 days ago
    Hello Ahmed,

    I believe you misunderstood my question - or I was not clear in my explanation.

    The issue I'm pointing is the fact that we have different URL paths to access the Product Inventory Management API described in several places:
    -  API User Guide /Specification PDF shows: "/productManagement/" and "/productInventoryManagement/"
    - Swagger API shows: "/productInventory/"

    So, the question is: which of these 3 paths/names is the correct one? In all other TMF APIs I've worked URL paths were consistent across all documents.

    Many thanks,
    Miguel Leal



    ------------------------------
    Miguel Leal
    Nokia
    ------------------------------