Open APIs

  • 1.  TMF672 - User Roles and Permissions API base path

    TM Forum Member
    Posted Oct 12, 2021 11:34
    Does anybody know what the correct base path for this API is.  There seems to be at least 3 different variants depending on where you look:
    1. Swagger spec linked of main Open API Table is at v4.0.0 and has /payment/v4/ - which seems odd and overlaps with TMF676 Payment Manamgent API
    2. API User Guide PDF documentation has /usersandroles/v1/
    3. swagger.yaml file in the Sample Implementation Code (which is at v4.0.1) has /userrolepermission/v4/
    Would be good to clarify documentation so it's consistent.

    ------------------------------
    Dave Pickard
    BT Group plc
    ------------------------------


  • 2.  RE: TMF672 - User Roles and Permissions API base path

    TM Forum Member
    Posted Oct 13, 2021 03:23
    Hi Dave
    I'm working on a major (v5) upgrade to Roles and Permissions API, and indeed I noticed a few days ago that the v4 base path in our design environment is incorrect for this API. Sorry :( .
    My proposal for v5 is userRolesAndPermissions, which matches the convention that the base path embodies the name of the API (removing spaces and doing camel case). But what I really should do is open a defect for v4 so that the team can review and agree on the correct base path.
    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: TMF672 - User Roles and Permissions API base path

    TM Forum Member
    Posted Oct 13, 2021 03:34
    Defect opened: https://projects.tmforum.org/jira/browse/AP-2995

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



  • 4.  RE: TMF672 - User Roles and Permissions API base path

    TM Forum Member
    Posted Oct 13, 2021 04:14

    Hi Jonathan,

    Thanks for the update and for raising defect.  I think your proposal makes sense.

    Regards

    Dave



    ------------------------------
    Dave Pickard
    BT Group plc
    ------------------------------



  • 5.  RE: TMF672 - User Roles and Permissions API base path

    Posted Oct 13, 2021 10:10
    my suggestion would be something like this below
    • /users/*
    • /users/roles/*
    • /users/roles/permissions/*


    ------------------------------
    Ramkumar Pillai
    Equinix, Inc
    ------------------------------