Improve format of documentation of "autoEncryption" option

XMLWordPrintableJSON

    • Type: Task
    • Resolution: Done
    • Priority: Major - P3
    • None
    • Affects Version/s: None
    • Component/s: Docs
    • None
    • PHP Drivers
    • 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?
    • None
    • None
    • None
    • None
    • None
    • None

      Improve formatting of autoEncryption in the driverOptions table.

      https://www.php.net/manual/en/mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions

      Instead of nesting a table in the description of the autoEncryption option, the list of options can be flatten.

       

      Option Type Description
      autoEncryption array  
      autoEncryption.keyVaultClient MongoDB\Driver\Manager  
      autoEncryption.keyVaultNamespace string  
      autoEncryption.kmsProviders    
      ...    
      ca_dir string  

       

      We use this format in the operators documentation. Example $collStats 

       

      • Remove the duplicate note:Automatic encryption is an enterprise-only ...
      •  

        1. image-2025-04-18-18-11-58-554.png
          224 kB
          Jérôme Tamarelle

              Assignee:
              Jérôme Tamarelle
              Reporter:
              Jérôme Tamarelle
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: