Uploaded image for project: 'Drivers'
  1. Drivers
  2. DRIVERS-3038

Rewrite CRUD options to be linkable

    • Type: Icon: Spec Change Spec Change
    • Resolution: Unresolved
    • Priority: Icon: Minor - P4 Minor - P4
    • None
    • Component/s: CRUD, Docs
    • None
    • Not Needed

      The CRUD spec currently specifies options to various operations as code blocks. This encourages duplication of options, and makes it difficult to link to individual options as they are all contained within a single code block.

      To make linking easier, options should be extracted from code blocks and described separately. To reduce duplication, we have several options. The first option would be to group applicable options:

      • Applicable to all operations
      • Applicable to read operations
        • Applicable to find
        • Applicable to findOne
        • ...
      • Applicable to write operations
        • Applicable to insert
        • Applicable to update
        • ...

      This could reduce duplication, but not entirely impossible if an option applies to multiple write operations but not all of them. This can be avoided by having a listing of all options, then including a table of options with the operations they apply to.

            Assignee:
            Unassigned Unassigned
            Reporter:
            andreas.braun@mongodb.com Andreas Braun
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: