Uploaded image for project: 'XWiki Platform'
  1. XWiki Platform
  2. XWIKI-14244

Clean the recycle bin API to make it more usable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 9.3.1
    • Fix Version/s: 9.4-rc-1
    • Component/s: Old Core
    • Labels:
      None
    • Difficulty:
      Unknown
    • Documentation:
      N/A
    • Similar issues:

      Description

      The recycle bin works with wiki-level index numbers for addressing restored documents, however, the API keeps asking for either (fullName, locale) String pairs or, some times even worse, XWikiDocument instances.

      Most of the time this creates confusion and some times it can even block really basic usecases (like getting a deleted document by ID, without knowing the actual XWikiDocument to which it belongs, since you should find out after getting it). See some details at https://github.com/xwiki/xwiki-platform/commit/1d8e1172757a75cda44398820505dacf384e0a56#commitcomment-21860183

      Since the API is very old and practice proved that asking for an XWikiDocument instance is not justified, an approach would be to deprecate the old signatures and expose simpler ones that are more clear and don`t get in the way of the API's user.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                enygma Eduard Moraru
                Reporter:
                enygma Eduard Moraru
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: