From 44cb9e691ab590fb1eb7c6f0d35dfac8713b3265 Mon Sep 17 00:00:00 2001
From: Kevin Albertson <kevin.albertson@mongodb.com>
Date: Mon, 17 Jun 2024 13:30:05 -0400
Subject: [PATCH] MONGOCRYPT-696 document "range" as unstable (#832)

* document "range" as unstable

* regenerate stripped header in pymongocrypt

Generated with:
```
python strip_header.py ../../src/mongocrypt.h | pbcopy -
```
---
 bindings/python/pymongocrypt/binding.py | 5 +++++
 src/mongocrypt.h                        | 5 +++++
 2 files changed, 10 insertions(+)

diff --git a/bindings/python/pymongocrypt/binding.py b/bindings/python/pymongocrypt/binding.py
index d821a142b..d709184f9 100644
--- a/bindings/python/pymongocrypt/binding.py
+++ b/bindings/python/pymongocrypt/binding.py
@@ -667,6 +667,7 @@ def _parse_version(version):
 /// String constant for setopt_algorithm "rangePreview" explicit encryption (deprecated in favor of "range")
 /// NOTE: "rangePreview" is experimental only and is not intended for public use.
 /// API for "rangePreview" may be removed in a future release.
+// NOTE: "Range" is currently unstable API and subject to backwards breaking changes.
 
 /**
  * Identify the AWS KMS master key to use for creating a data key.
@@ -852,6 +853,7 @@ def _parse_version(version):
  *
  * NOTE: "rangePreview" is experimental only and is not intended for public use.
  * API for "rangePreview" may be removed in a future release.
+ * NOTE: "range" is currently unstable API and subject to backwards breaking changes.
  *
  * This method expects the passed-in BSON to be of the form:
  * { "v" : FLE2RangeFindDriverSpec }
@@ -1362,6 +1364,7 @@ def _parse_version(version):
 
 /**
  * @brief Opt-into use of Queryable Encryption Range V2 protocol.
+ * NOTE: "range" is currently unstable API and subject to backwards breaking changes.
  *
  * @param[in] crypt The @ref mongocrypt_t object.
  *
@@ -1413,6 +1416,7 @@ def _parse_version(version):
 
 /**
  * Set options for explicit encryption with the "range" algorithm.
+ * NOTE: "range" is currently unstable API and subject to backwards breaking changes.
  *
  * @p opts is a BSON document of the form:
  * {
@@ -1435,6 +1439,7 @@ def _parse_version(version):
 // 'rangePreview' is deprecated in favor of range.
 /// NOTE: "rangePreview" is experimental only and is not intended for public use.
 /// API for "rangePreview" may be removed in a future release.
+/// NOTE: "range" is currently unstable API and subject to backwards breaking changes.
 
 """
 )
diff --git a/src/mongocrypt.h b/src/mongocrypt.h
index 24bb5b445..605277647 100644
--- a/src/mongocrypt.h
+++ b/src/mongocrypt.h
@@ -690,6 +690,7 @@ bool mongocrypt_ctx_setopt_algorithm(mongocrypt_ctx_t *ctx, const char *algorith
 /// NOTE: "rangePreview" is experimental only and is not intended for public use.
 /// API for "rangePreview" may be removed in a future release.
 #define MONGOCRYPT_ALGORITHM_RANGEPREVIEW_DEPRECATED_STR "RangePreview"
+// NOTE: "Range" is currently unstable API and subject to backwards breaking changes.
 #define MONGOCRYPT_ALGORITHM_RANGE_STR "Range"
 
 /**
@@ -883,6 +884,7 @@ bool mongocrypt_ctx_explicit_encrypt_init(mongocrypt_ctx_t *ctx, mongocrypt_bina
  *
  * NOTE: "rangePreview" is experimental only and is not intended for public use.
  * API for "rangePreview" may be removed in a future release.
+ * NOTE: "range" is currently unstable API and subject to backwards breaking changes.
  *
  * This method expects the passed-in BSON to be of the form:
  * { "v" : FLE2RangeFindDriverSpec }
@@ -1418,6 +1420,7 @@ void mongocrypt_setopt_bypass_query_analysis(mongocrypt_t *crypt);
 
 /**
  * @brief Opt-into use of Queryable Encryption Range V2 protocol.
+ * NOTE: "range" is currently unstable API and subject to backwards breaking changes.
  *
  * @param[in] crypt The @ref mongocrypt_t object.
  *
@@ -1473,6 +1476,7 @@ bool mongocrypt_ctx_setopt_query_type(mongocrypt_ctx_t *ctx, const char *query_t
 
 /**
  * Set options for explicit encryption with the "range" algorithm.
+ * NOTE: "range" is currently unstable API and subject to backwards breaking changes.
  *
  * @p opts is a BSON document of the form:
  * {
@@ -1498,6 +1502,7 @@ bool mongocrypt_ctx_setopt_algorithm_range(mongocrypt_ctx_t *ctx, mongocrypt_bin
 /// NOTE: "rangePreview" is experimental only and is not intended for public use.
 /// API for "rangePreview" may be removed in a future release.
 #define MONGOCRYPT_QUERY_TYPE_RANGEPREVIEW_DEPRECATED_STR "rangePreview"
+/// NOTE: "range" is currently unstable API and subject to backwards breaking changes.
 #define MONGOCRYPT_QUERY_TYPE_RANGE_STR "range"
 
 #endif /* MONGOCRYPT_H */