Skip to content

Commit d98e44e

Browse files
authored
PYTHON-3245 Fix docs for index_key_id (#960)
1 parent 154d878 commit d98e44e

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

pymongo/encryption.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -591,11 +591,12 @@ def encrypt(
591591
:class:`~bson.binary.Binary` with subtype 4 (
592592
:attr:`~bson.binary.UUID_SUBTYPE`).
593593
- `key_alt_name`: Identifies a key vault document by 'keyAltName'.
594-
- `index_key_id` (bytes): the index key id to use for Queryable Encryption.
594+
- `index_key_id`: The index key id to use for Queryable Encryption. Must be
595+
a :class:`~bson.binary.Binary` with subtype 4 (:attr:`~bson.binary.UUID_SUBTYPE`).
595596
- `query_type` (int): The query type to execute. See
596597
:class:`QueryType` for valid options.
597598
- `contention_factor` (int): The contention factor to use
598-
when the algorithm is "Indexed".
599+
when the algorithm is :attr:`Algorithm.INDEXED`.
599600
600601
:Returns:
601602
The encrypted value, a :class:`~bson.binary.Binary` with subtype 6.

0 commit comments

Comments
 (0)