Merge remote-tracking branch 'origin/topic/timw/storage-framework-script-docs-updates'

* origin/topic/timw/storage-framework-script-docs-updates:
  Minor changes to storage framework script docs
This commit is contained in:
Tim Wojtulewicz 2025-04-25 06:40:46 -07:00
commit c4613cf573
4 changed files with 14 additions and 8 deletions

View file

@ -1,3 +1,7 @@
7.2.0-dev.636 | 2025-04-25 06:40:46 -0700
* Minor changes to storage framework script docs (Tim Wojtulewicz, Corelight)
7.2.0-dev.634 | 2025-04-25 08:40:29 -0400 7.2.0-dev.634 | 2025-04-25 08:40:29 -0400
* Bump Spicy (Evan Typanski, Corelight) * Bump Spicy (Evan Typanski, Corelight)

View file

@ -1 +1 @@
7.2.0-dev.634 7.2.0-dev.636

View file

@ -6235,7 +6235,7 @@ export {
TIMEOUT, TIMEOUT,
## Connection to backed was lost unexpectedly. ## Connection to backed was lost unexpectedly.
CONNECTION_LOST, CONNECTION_LOST,
## Generic operation failed. ## Generic operation failure.
OPERATION_FAILED, OPERATION_FAILED,
## Key requested was not found in backend. ## Key requested was not found in backend.
KEY_NOT_FOUND, KEY_NOT_FOUND,
@ -6258,10 +6258,12 @@ export {
## One of a set of backend-redefinable return codes. ## One of a set of backend-redefinable return codes.
code: ReturnCode; code: ReturnCode;
## An optional error string. This should be set when the ## An optional error string. This should be set when the
## ``code`` field is not set ``SUCCESS``. ## ``code`` field is not set to ``SUCCESS``.
error_str: string &optional; error_str: string &optional;
## An optional value returned by ``get`` operations when a match ## An optional value for operations that can return data. ``get``
## was found the key requested. ## operations uses this to return the value when a match was found
## for the key requested. ``open_backend`` uses this to return the
## backend handle on successful connections.
value: any &optional; value: any &optional;
}; };
} }

View file

@ -18,9 +18,9 @@ export {
# ``server_host`` field must be unset. # ``server_host`` field must be unset.
server_unix_socket: string &optional; server_unix_socket: string &optional;
# Prefix used in key values stored to differentiate varying types of data # Prefix used in keys stored to differentiate varying types of data on the
# on the same server. Defaults to an empty string, but preferably should # same server. Defaults to an empty string, but preferably should be set
# be set to a unique value per Redis backend opened. # to a unique value per Redis backend opened.
key_prefix: string &default=""; key_prefix: string &default="";
}; };
} }