Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-70048

Dropbox Search API: /files/search is being retired in favor of /files/search_v2

    XMLWordPrintable

    Details

    • Testing Instructions:
      Hide

      Confirm unit/behat tests passes.

      Manual test

      1. Setup the dropbox repository by following the instructions - https://docs.moodle.org/310/en/Dropbox_repository
      2. Create a dropbox account and upload the extracted attached archive - test.zip
      3. Log in as admin
      4. Go to private files and click on 'Add file' icon
      5. Click on the dropbox option in the filepicker and log into the dropbox account from #2
      6. Confirm you can view the files that were uploaded in #2
      7. Search for 'started' by entering it in the search box
      8. Confirm you are returned >100 files (this checks the api call and paginated results)
        1. Check this by inspecting the network call under the 'list' node in the response.
      9. Confirm there are no issues when you select a file and add it the private files
      Show
      Confirm unit/behat tests passes. Manual test Setup the dropbox repository by following the instructions - https://docs.moodle.org/310/en/Dropbox_repository Create a dropbox account and upload the extracted attached archive - test.zip Log in as admin Go to private files and click on 'Add file' icon Click on the dropbox option in the filepicker and log into the dropbox account from #2 Confirm you can view the files that were uploaded in #2 Search for 'started' by entering it in the search box Confirm you are returned >100 files (this checks the api call and paginated results) Check this by inspecting the network call under the 'list' node in the response. Confirm there are no issues when you select a file and add it the private files
    • Affected Branches:
      MOODLE_35_STABLE, MOODLE_37_STABLE, MOODLE_38_STABLE, MOODLE_39_STABLE
    • Fixed Branches:
      MOODLE_310_STABLE, MOODLE_39_STABLE
    • Pull from Repository:
    • Pull 3.9 Branch:
    • Pull 3.10 Branch:
      MDL-70048-310
    • Pull 3.11 Branch:
      MDL-70048-311
    • Pull Master Branch:
      MDL-70048-master
    • Story Points:
      5
    • Sprint:
      4.0 holding pattern 11

      Description

      We got this email from DropBox today:

      Hi,

      We’re reaching out to notify you of an upcoming change to the Dropbox API that may affect your app(s)–Moodle, which are using the /2/files/search endpoint on the Dropbox API.

      Starting on February 28th, 2021, the deprecated /2/files/search endpoint will be retired. At that point, any further calls to /2/files/search will fail. Please migrate your app to /2/files/search_v2.

      All existing features have been migrated to /2/files/search_v2 and several improvements have been made. In addition to enhanced performance and reliability, we’ve added support for many new file types and added new features such as filtering by file extension. You can read more about it in the recent blog post, Search Files Using the Dropbox API. If you have questions or need help, you can post on our developer forum or submit a support ticket directly.

      Thank you for your attention! We hope you enjoy the new features available on the Search API.

      Sincerely,

      • DBX Platform Team

       

      I see a reference to this deprecated API here: https://github.com/moodle/moodle/blob/master/repository/dropbox/classes/dropbox.php#L243

      Can a patch be made to previous supported versions of Moodle as well?

        Attachments

        1. 70048-310.png
          70048-310.png
          1.47 MB
        2. 70048-311.png
          70048-311.png
          1.46 MB
        3. 70048-39.png
          70048-39.png
          1.46 MB
        4. 70048-master.png
          70048-master.png
          1.47 MB
        5. test.zip
          35 kB

          Activity

            People

            Assignee:
            peterdias Peter Dias
            Reporter:
            rex Rex Lorenzo
            Peer reviewer:
            Mihail Geshoski Mihail Geshoski
            Integrator:
            Andrew Lyons Andrew Lyons
            Tester:
            Andrew Lyons Andrew Lyons
            Participants:
            Component watchers:
            Adrian Greeve, Jake Dallimore, Mathew May, Mihail Geshoski, Peter Dias, Sujith Haridasan
            Votes:
            2 Vote for this issue
            Watchers:
            9 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:
              Fix Release Date:
              8/Mar/21

                Time Tracking

                Estimated:
                Original Estimate - 0 minutes
                0m
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 2 days, 4 hours, 20 minutes
                2d 4h 20m