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

make search indexes API public

XMLWordPrintableJSON

    • Needed
    • Hide

      1. What would you like to communicate to the user about this feature?

      We would like a section in the Node driver documentation telling users they can manage search indexes with the driver. We would also like this to link to the search indexes documentation as well.

      2. Would you like the user to see examples of the syntax and/or executable code and its output?

      Not necessary!
      3. Which versions of the driver/connector does this apply to?

      driver 5.7.0+

      Show
      1. What would you like to communicate to the user about this feature? We would like a section in the Node driver documentation telling users they can manage search indexes with the driver. We would also like this to link to the search indexes documentation as well. 2. Would you like the user to see examples of the syntax and/or executable code and its output? Not necessary! 3. Which versions of the driver/connector does this apply to? driver 5.7.0+

      Use Case

      As a... __ Atlas Search user
      I want...  to manage my indexes from a driver
      So that... I don't have to use the Atlas UI

      User Impact

      N/A

      Dependencies

      • mongosh, see linked ticket below

      Unknowns

      N/A

      Acceptance Criteria

      Implementation Requirements

      • remove the `internal` tags and add a `public` tag from the following types / classes_
        • ListSearchIndexesCursor
        • ListSearchIndexesOptions
        • SearchIndexDescription
      • remove the `internal` tags and add a `public` tag from the following methods_
        • Collection.dropSearchIndex
        • Collection.updateSearchIndex
        • Collection.createSearchIndex
        • Collection.createSearchIndexes
        • Collection.listSearchIndexes

      Testing Requirements

      N/A

      Documentation Requirements

      • Paragraph saying you can manage your Atlas Search Indexes using these APIs, and linking over to the top-level documentation

      Follow Up Requirements

      N/A

            Assignee:
            bailey.pearson@mongodb.com Bailey Pearson
            Reporter:
            bailey.pearson@mongodb.com Bailey Pearson
            Durran Jordan
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated:
              Resolved: