Fast follow for SC-59450/#5379 (#5382)

Update docs for REST enumeration config options. --- TYPE: NO_HISTORY --------- Co-authored-by: Shaun Reed <[email protected]>
TileDB-Inc · Nov 20, 2024 · e651f9a · e651f9a
1 parent 38e3aed
commit e651f9a
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/tiledb/api/c_api/config/config_api_external.h b/tiledb/api/c_api/config/config_api_external.h
@@ -754,8 +754,12 @@ TILEDB_EXPORT void tiledb_config_free(tiledb_config_t** config) TILEDB_NOEXCEPT;
  *    with the open array <br>
  *    **Default**: true
  * - `rest.load_enumerations_on_array_open` <br>
- *    If true, enumerations will be loaded and sent to server together with
- *    the open array.
+ *    If true, enumerations will be loaded for the latest array schema and
+ *    sent to server together with the open array.
+ *    **Default**: false
+ * - `rest.load_enumerations_on_array_open_all_schemas` <br>
+ *    If true, enumerations will be loaded for all schemas and sent to server
+ *    together with the open array.
  *    **Default**: false
  * - `rest.use_refactored_array_open` <br>
  *    If true, the new REST routes and APIs for opening an array

diff --git a/tiledb/sm/cpp_api/config.h b/tiledb/sm/cpp_api/config.h
@@ -928,12 +928,12 @@ class Config {
    *    together with the open array <br>
    *    **Default**: true
    * - `rest.load_enumerations_on_array_open` <br>
-   *    If true, enumerations will be loaded for the latest array schema on
-   *    array open.
+   *    If true, enumerations will be loaded for the latest array schema and
+   *    sent to server together with the open array.
    *    **Default**: false
    * - `rest.load_enumerations_on_array_open_all_schemas` <br>
-   *    If true, enumerations will be loaded for all array schemas on array
-   *    open.
+   *    If true, enumerations will be loaded for all array schemas and sent to
+   *    server together with the open array.
    *    **Default**: false
    * - `rest.use_refactored_array_open` <br>
    *    If true, the new REST routes and APIs for opening an array will be used