Skip to Main Content
Feature Request FR-2887
Product Area APIs
Status ROADMAP

16 Voters

Add Legacy and Deprecated warnings in JS API

paulo künzel Public · Dec 13 2022

Idea Summary
It would be nice to have a clearer idea of what is deprecated or legacy in the apex.oracle.com/jsapi

Use Case
It makes it easier to know what should be avoided or that will become obsolete in the near future.

Preferred Solution (Optional)
A label or text by the side of the function name would suffice. Further explanation as to why, when and what to use instead would be awesome.

This is currently on the roadmap for a future release of Oracle APEX.

Comments

Comments

  • vinci.amorim OP 3.3 years ago

    good

  • hamza alabbasi OP 3.3 years ago

    Totally agree.

  • vincent morneau Admin OP 2.6 years ago

    Hi @paulo künzel ,

    No doubt there is room to improve the JS API. Can you point to some specific examples of where you'd add Legacy and Deprecated notices?

    For example, you can find the Legacy JavaScript APIs in https://docs.oracle.com/en/database/oracle/apex/23.1/aexjs/index.html and here's one specific deprecated example in the apex.pwa namespace: https://docs.oracle.com/en/database/oracle/apex/23.1/aexjs/apex.pwa.html#.getInstallText

  • paulo künzel OP 2.6 years ago

    Hi @vincent morneau,

    Thanks for the reply and interest. Something as simple as the deprecated flag that you provided is awesome and probably enough :) . What we might need then is a review of the documentation to write the appropriate flags.

    Yes, I can point, I actually had to dig it from Twitter/X which was what generated this request.

    Just checked and the documentation is still showing it as a possible function to be used https://docs.oracle.com/en/database/oracle/apex/23.1/aexjs/global.html#$f_CheckAll.

    I understand this might be an odd idea and keeping the documentation up to date is hardly ever a priority in most places, but I really make an effort to use as much of the provided functionalities instead of building my own.

    Although the news made me unsure as what can I trust in the Non-namespace API section, I really like the fact that the issue was brought to my attention when I posted it so I could be careful about it.

  • vincent morneau Admin OP 2.6 years ago

    That makes sense! We should be clearer about the status of the non namespace APIs. Thanks for clearing that up.

  • paulo künzel OP 2.6 years ago

    Thanks Vincent, that would be awesome,

    Tbh, idk if its in any other places, but the non namespace is an great starting point.

  • dsievers OP 2.2 years ago

    If the “APEX Advisor” could warn about these as well, that would be amazing!