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