Add deprecated tag to bson binary subtype 2

XMLWordPrintableJSON

    • Type: Improvement
    • Resolution: Fixed
    • Priority: Minor - P4
    • bson-6.10.5
    • Affects Version/s: None
    • Component/s: BSON
    • 1
    • Not Needed
    • None
    • Hide

      Create a copy of the Kickoff Template with the issue key (NODE-XXX) in the filename and share a link to the new doc via this field.

      Show
      Create a copy of the Kickoff Template with the issue key (NODE-XXX) in the filename and share a link to the new doc via this field.
    • Not Needed
    • 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... user of bson
      I want... the binary subtype 2 to be marked as deprecated
      So that... I am alerted to the preferred subtype (in this case, 0)

      The official bson spec has the following text:

      unsigned_byte(2) Binary (Old) - This used to be the default subtype, but was deprecated in favor of subtype 0. Drivers and tools should be sure to handle subtype 2 appropriately. The structure of the binary data (the byte* array in the binary non-terminal) must be an int32 followed by a (byte*). The int32 is the number of bytes in the repetition.

      User Experience

      • Users accessing the binary SUBTYPE_BYTE_ARRAY (subtype 2) property will see a deprecation message explaining that it is deprecated in favor of SUBTYPE_DEFAULT (subtype 0)

      Dependencies

      • N/A

      Risks/Unknowns

      • N/A

      Acceptance Criteria

      Implementation Requirements

      • Add the TS deprecated tag to SUBTYPE_BYTE_ARRAY, pointing to SUBTYPE_DEFAULT instead (use analogous wording to SUBTYPE_UUID_OLD)

      Testing Requirements

      • N/A

      Documentation Requirements

      • N/A - this is a docs change

      Follow Up Requirements

      • N/A

            Assignee:
            Bailey Pearson
            Reporter:
            Daria Pardue
            Durran Jordan
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: