Clean up the unclear new_collection option from rename

XMLWordPrintableJSON

    • Type: Improvement
    • Resolution: Unresolved
    • Priority: Minor - P4
    • None
    • Affects Version/s: None
    • Component/s: TypeScript
    • Not Needed
    • None
    • Hide

      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?

      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?
    • None
    • None
    • None
    • None
    • None
    • None

      Use Case

      As a... Node driver user
      I want... autocomplete and TS to prompt me with usable & correct options
      So that... I am able to stay in my IDE and learn how to call driver APIs as I code.

      Reference: https://github.com/mongodb/node-mongodb-native/blob/f433e11a092d01457e5aa7c6dce5ee8b5ef1ffb8/src/operations/rename.ts#L14

      User Experience

      • The new_collection option on the rename API is properly marked as unused by removing or deprecating it.

      Dependencies

      • None

      Risks/Unknowns

      • Is this really a breaking change?

      Acceptance Criteria

      Implementation Requirements

      • TODO: Decide if this can be done as a fix
      • Deprecate or remove the new_collection option from RenameOptions
      • Improve the TS doc

      Testing Requirements

      • If deprecated add a type deprecation test to catch regressions

      Documentation Requirements

      • None beyond the above.

      Follow Up Requirements

      • None

        1.
        		 Deprecate new_collection option in RenameCollectionOptions NODE-7330 Sub-task Needs Verification Bailey Pearson  
        2.
        		 Remove new_collection option NODE-7332 Sub-task Ready for Work Unassigned  

            Assignee:
            Unassigned
            Reporter:
            Neal Beeken
            None
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: