docs: update context-aware encryption and improve consistency#14
Merged
Conversation
Add context type compatibility table to clarify which encryption contexts work with which index types. Document that `ste_vec` indexes do not support encryption context to prevent configuration errors. Update bulk operation examples to show context usage patterns.
Add test for `ste_vec` context incompatibility to verify that using encryption context with `ste_vec` indexes throws expected exceptions during decryption. This documents the known limitation where context is ignored during encryption, therefore causing decryption with the same context to fail. Add bulk operations test with context to verify roundtrip encryption and decryption works correctly when context is provided for supported index types (`unique`, `ore`, `match`).
Standardize encryption/decryption variable naming throughout README examples for consistency. Updates variable names to be more descriptive and explicit about their purpose. This improves code clarity and maintains consistency across the codebase documentation.
Standardize encryption/decryption variable naming throughout integration tests for consistency. Updates variable names to be more descriptive and explicit about their purpose. This improves test readability and maintains consistency across the codebase.
Standardize configuration and response terminology throughout README for consistency. Updates "field" references to "parameter" and "response field" to "response parameter". This improves documentation consistency and uses more precise terminology.
Update the example input for the `int` data type in the README to use `2147483647`, the maximum value for a signed 32-bit integer, instead of `29`.
coreyhn
force-pushed
the
docs/standardize-naming-and-context
branch
from
93c35b6 to
13a83ff
Compare
calvinbrewer
approved these changes
Jul 7, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the documentation and testing to update context-aware encryption and improve consistency.
Adds a context type compatibility table to clarify which encryption contexts work with which index types, helping prevent configuration errors. Also documents that
ste_vecindexes do not support encryption context to help avoid decryption failures. Updates bulk operation examples to show context usage patterns.Standardizes variable names throughout README examples to be more descriptive and explicit to improve code clarity and maintain consistency across the codebase documentation.
Improves terminology consistency by standardizing configuration and response terminology, updating "field" references to "parameter" throughout the documentation for more precise language. Also updates the
intdata type example to use2147483647(32-bit max value) instead of29(follows the pattern fromsmall_intandbig_int).Enhances testing by adding integration tests for encryption context functionality, including a test to verify that using encryption context with
ste_vecindexes throws expected exceptions during decryption, documenting the known limitation. Adds bulk operations test with context to verify roundtrip encryption and decryption works correctly when context is provided for supported index types (unique,ore,match). Updates integration test variable names to match the improved conventions for consistency across the codebase.These changes improve code clarity, maintains consistency across documentation and tests, and provides better guidance when working with encryption contexts.