Uploaded image for project: 'Node.js Driver'
  1. Node.js Driver
  2. NODE-5979

BSON API documentation not present in driver API documentation

XMLWordPrintableJSON

    • Type: Icon: Task Task
    • Resolution: Fixed
    • Priority: Icon: Major - P3 Major - P3
    • 6.5.0
    • Affects Version/s: None
    • Component/s: None
    • Labels:
    • 0
    • Not Needed
    • 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?

      Use Case

      As a Node.js driver or js BSON user
      I want to read API documentation for BSON
      So that I know how to use the library

      Working: https://mongodb.github.io/node-mongodb-native/5.3/classes/BSON.ObjectId.html

      External is hidden by default: https://mongodb.github.io/node-mongodb-native/6.3/classes/BSON.ObjectId.html

      User Impact

      • There is no BSON API documentation for recent versions unless you check the "External" box

      Dependencies

      • Typedoc

      Unknowns

      • Will a newer version of typedoc fix this?
      • Is there a configuration we can set to make sure the BSON docs are shown by default in the driver docs?

      Acceptance Criteria

      Implementation Requirements

      • Make BSON API documentation available

      Testing Requirements

      • None

      Documentation Requirements

      • None

      Follow Up Requirements

      • None

            Assignee:
            neal.beeken@mongodb.com Neal Beeken
            Reporter:
            neal.beeken@mongodb.com Neal Beeken
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: