Open APIs

 View Only
  • 1.  Issues with Open API Directory Re-Design

    TM Forum Member
    Posted Jun 21, 2024 03:19

    I noticed that the openapi directory received a design update. Looking good 👍 I like the new structure by domains. It's a lot easier to find a spec.

    Just a couple of issues

    • I can't find TMF679 ProductOfferingQualification anymore. It's still listed in the specifications. I haven't checked all specifications, I just noticed searching for it. B
    • The header search icon in the top right next to the profile doesn't work in the new design. It is working in the old design.
    • You can't insert space in the directorie's search bar, since it opens/closes the filter box. This means that you can't properly search "Service Catalog" for example.

    If this isn't the right place for this kind of feedback, please let me know where to raise the issue.



    ------------------------------
    With kind regards
    Omar Sood
    conology
    ------------------------------


  • 2.  RE: Issues with Open API Directory Re-Design

    TM Forum Member
    Posted 29 days ago

    Thanks Omar for the feedback, I'm sending it on to the relevant focals.

    Teething troubles, hopefully.



    ------------------------------
    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: Issues with Open API Directory Re-Design

    TM Forum Member
    Posted 28 days ago

    Hi Omar,

    Thank you very much for your feedback. It's comments like these that allow us to constantly improve our API offering. Please keep them coming.

    Regarding TMF679, we are aware of that API being missing and we aim to have that back up on the new Directory ASAP. I have already fed your other observations about issues with search to the relevant teams. Again, like the missing API, we aim to address these as quickly as possible.

    Thank you again.

    Regards,

    Darren



    ------------------------------
    Darren Nicholls
    TM Forum
    ------------------------------



  • 4.  RE: Issues with Open API Directory Re-Design

    TM Forum Member
    Posted 27 days ago

    Hi Darren and TM Forum Team,

    I want to congratulate everyone involved in the fantastic work done with the revamped Open API table. The new design update has significantly enhanced usability, making it much easier and more user-friendly to navigate and find information. The integration of the ODA component with the Open API is particularly noteworthy and marks a positive step forward.

    However, I noticed that in the new version of the Open API table, there are fewer APIs listed compared to the previous version. One specific example is the absence of TMF640.

    Could you please list down all the APIs (that have not been listed in the new Open API table but were present in previous version of the Open API Table) and their reason for not being listed? This will help me (and all the other members) to be better aware of this change and we don't have to keep reporting this one by one.

    Understanding the rationale behind the APIs that have missed out in getting listed in the new directory will help us ensure alignment and possibly address any concerns that may arise. Please note that we have these APIs in our production environments and understanding the reason for not being listed is very important for us.

    Once again, congratulations to the team for achieving such a remarkable improvement in usability and design. Looking forward to your insights on the TMF640 API in particular and all the other APIs that have not been listed.



    ------------------------------
    Abdul Majid Hussain
    Telstra Corporation
    ------------------------------



  • 5.  RE: Issues with Open API Directory Re-Design

    TM Forum Member
    Posted 27 days ago

    Hi Abdul,

    Firstly thank you very much for your kind, positive words regarding the updated API Directory. We continue to strive for a better user experience and it's great to hear we are moving in the right direction. I'll ensure your comments are shared with the team internally.

    Regarding missing APIs, I can only apologize for this. We are in the process of conducting an investigation into what may have caused this and fixing the issue to return the missing APIs to the Directory. There is no other reason for an API to have been omitted from the Directory that was previously on the API table. I'll let you know as soon as we have a timeline for returning the APIs to the Directory.

    Regards,

    Darren



    ------------------------------
    Darren Nicholls
    TM Forum
    ------------------------------



  • 6.  RE: Issues with Open API Directory Re-Design

    TM Forum Member
    Posted 22 days ago

    Hi @Darren Nicholls

    Given the well-documented issues about the unreliability of searching for APIs via any method other than the Open API Table, e.g.

    • https://engage.tmforum.org/discussion/warning-about-wrong-tmf670-api-documentation-on-tmf-website
    • https://engage.tmforum.org/discussion/tmf720-differences-between-the-open-apis-table-and-github-repo-swagger-specs

    Can TM Forum look to restore the table until the Directory has been tested?

    It is difficult to get the APIs taken seriously by people who are not already "in the club" if they can't access the definitions reliably.

    Between losing the APIs, and the ability to search for more than 1 word (spacebar doesn't function), it's difficult to get enthused by the new design.

    Similarly, please confirm how to access the "Pre Production" table , this was previously a click away but isn't obvious on new page how to access it.

    For any others who have to access APIs meanwhile, the table can be found at https://www.tmforum.org/oda/open-apis/table/ (the trailing / is material - if you miss it you are redirected to the directory)



      ------------------------------
      Andrew Torrance
      Cerillion Technologies Limited
      ------------------------------



    1. 7.  RE: Issues with Open API Directory Re-Design

      TM Forum Member
      Posted 21 days ago

      Hi Andrew,

      Thank you very much for your feedback. While I completely understand your frustrations, and we are working as fast as possible to fix the issues, switching back to the old table is not an option. The move to the Directory was made to solve three main objectives:

      • Consolidation of all of our APIs from three tables (Pre production, production and historic) to a single view.
      • This Directory then links to a single page for each API that allows users to navigate the increasing number of versions of APIs (V4, Gen5, ASYNC, DCS etc.)
      • Start to bridge the gap between ODA Product. We've added links on the API pages to associated Components, and will be linking back to API Pages post DTW.

      I'll aim to have an estimated fix date to you on this thread by the end of this week. In the meantime, the missing APIs can still be accessed just not via the Directory. The links are as follows:

      TMF640 - https://www.tmforum.org/oda/open-apis/directory/service-activation-management-api-TMF640/v5.0.0

      TMF686 - https://www.tmforum.org/oda/open-apis/directory/topology-management-api-TMF686 

      TMF649 - https://www.tmforum.org/oda/open-apis/directory/performance-thresholding-management-api-TMF649/v4.0.0

      Regarding your point about pre-production, as mentioned in my objectives above, the aim of the Directory was to consolidate those three tables down to a single view. You can filter for pre-production APIs by using the "preview" filter in the search, or by navigating to the API of your choice and browsing the available versions of that API from there.

      Again, your feedback is valued and we will be doing everything in our power to address your concerns.

      Regards,

      Darren



      ------------------------------
      Darren Nicholls
      TM Forum
      ------------------------------



    2. 8.  RE: Issues with Open API Directory Re-Design

      TM Forum Member
      Posted 21 days ago

      Hi Darren,

      POQ appears to have been restored today, so thank you for that.

      Regarding the first objective + pre-production,  I'm not sure if I'm missing something. Taking POQ, where v4 is current and v5 is preview, they are presented the same.

      You can choose preview from the top and see which versions disappar, but that replaces the search term (so if i previously fitlered "Product" and click preview i lose my thread), so it is no more a single view than the 3 tables were, and they were filterable.

      Alternatrively clicking through (so one API at a time)

      There is no indication what the status of each version is unless you click through for each API in turn, and click through each version (the icons have no tooltip, key or aria description)

      Whereas before if i wanted to see  all Product APIs in Pre-Production, this was easy...



      ------------------------------
      Andrew Torrance
      Cerillion Technologies Limited
      ------------------------------



    3. 9.  RE: Issues with Open API Directory Re-Design

      TM Forum Member
      Posted 21 days ago

      Hi Andrew,

      Correct, the APIs that had been identified as missing are in the process of being added back to the Directory. Thank you again for your patience.

      Your feedback on the current API Directory navigation is much appreciated, and I'd like to discuss this with you in greater detail. As with most products, we aimed to launch an MVP and learn from users what they like and don't like about the experience, this will lead in to the ongoing development of the Directory. We have some ambitious plans for the Directory moving forward and I'd be keen to share these with you.

      Regards,

      Darren



      ------------------------------
      Darren Nicholls
      TM Forum
      ------------------------------