Ensure search index definition schema changes don't affect drivers

XMLWordPrintableJSON

    • Type: Spec Change
    • Resolution: Unresolved
    • Priority: Major - P3
    • None
    • Component/s: Index Management
    • None

      Summary

      What is the problem or use case, what are we trying to achieve?

      The search team is introducing a new search index definition-related feature that adds a top level field called `typeSets` and now allows users to have the value of dynamic be either a `boolean/object` following a specific structure. You can read more about the syntax of this feature in the syntax document.

      We would like to use this ticket to ensure that there is no strict validation present for the index definition on the `createSearchIndex/updateSearchIndex` commands for the driver which would error if a user tries to define a search index using the new syntax introduced as part of this feature. 

      Motivation

      Who is the affected end user?

      Who are the stakeholders?

      All users who are trying to define an index definition with `typeSets`/`dynamic` as a `object`. 

      How does this affect the end user?

      Are they blocked? Are they annoyed? Are they confused?

      They would see that this feature has been released and is available via defining a search index definition in MMS/admin API but not the drivers

      How likely is it that this problem or use case will occur?

      Main path? Edge case?

      If there is strict validation, there is a 100% chance users will experience errors. 

      If the problem does occur, what are the consequences and how severe are they?

      Minor annoyance at a log message? Performance concern? Outage/unavailability? Failover can't complete?

      • Breaks a user's current workflow where they are defining search index definitions programmatically and the only option they have is using the admin API or manually defining indexes in the UI.
      • Increases developer friction and reduces adoption of this feature when released

      Is this issue urgent?

      Does this ticket have a required timeline? What is it?

      August 25th is the planned mongot release that will include this feature

      Is this ticket required by a downstream team?

      Needed by e.g. Atlas, Shell, Compass?

      Unsure

      Is this ticket only for tests?

      Does this ticket have any functional impact, or is it just test improvements?

      Not for tests, to check if there is strict schema validation for a search index definition and if so, relax that constraint. 

      Acceptance Criteria

      What specific requirements must be met to consider the design phase complete?

              Assignee:
              Unassigned
              Reporter:
              Puneeth Bikkumanla (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: