Uploaded image for project: 'Core Server'
  1. Core Server
  2. SERVER-55444

APIStrictError should describe how to migrate from unversioned APIs

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major - P3
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 5.0.0-rc5, 5.1.0-rc0
    • Component/s: Query Language
    • Labels:
      None
    • Backwards Compatibility:
      Fully Compatible
    • Backport Requested:
      v5.0
    • Sprint:
      Query Optimization 2021-05-17, Query Optimization 2021-06-28

      Description

      When a client tries to use a feature that's not in API Version 1, if the client passes apiVersion: "1" and apiStrict: true, the server replies with APIStrictError. In as many cases as possible, let's accompany the error with a message describing how to migrate to the Versioned API. E.g., when "mapreduce" returns APIStrictError, it should say, "Use aggregate instead", and link to the docs. Ideally, there is a page in the docs that helps users rewrite their mapreduce jobs as aggregations.

      Similar for "distinct" (if we choose not to include it in Version 1), and other unversioned APIs with versioned alternatives.

        Attachments

          Activity

            People

            Assignee:
            maddie.zechar Maddie Zechar
            Reporter:
            jesse A. Jesse Jiryu Davis
            Participants:
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: