Skip to content

docs: add EvaluationDetail table documentation #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 11, 2024
Merged

docs: add EvaluationDetail table documentation #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion launchdarkly-server-sdk-redis.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/***
Server-side SDK for LaunchDarkly Redis store.
Redis Data Source for LaunchDarkly Lua Server SDK.
@module launchdarkly-server-sdk-redis
*/

Expand Down
23 changes: 18 additions & 5 deletions launchdarkly-server-sdk.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1416,6 +1416,19 @@ LuaLDContextPrivateAttributes(lua_State *const l)
return 1;
}

/**
EvaluationDetail contains extra information related to evaluation of a flag.

@field kind string, one of: "OFF","FALLTHROUGH", "TARGET_MATCH", "RULE_MATCH",
"PREREQUISITE_FAILED", "ERROR", "UNKNOWN".
@field errorKind string, only present if 'kind' is "ERROR"; one of: "CLIENT_NOT_READY",
"FLAG_NOT_FOUND", "USER_NOT_SPECIFIED", "MALFORMED_FLAG", "WRONG_TYPE",
"MALFORMED_FLAG", "EXCEPTION", "UNKNOWN".
@field inExperiment bool, whether the flag was part of an experiment.
@field variationIndex int, only present if the evaluation was successful. The zero-based index of the variation.
@field value LDJSON, the value of the flag.
@table EvaluationDetail
*/

/**
Evaluate a boolean flag
Expand Down Expand Up @@ -1459,7 +1472,7 @@ Evaluate a boolean flag and return an explanation
@tparam context context An opaque context object from @{makeUser} or @{makeContext}
@tparam string key The key of the flag to evaluate.
@tparam boolean fallback The value to return on error
@treturn table The evaluation explanation
@return @{EvaluationDetail}
*/
static int
LuaLDClientBoolVariationDetail(lua_State *const l)
Expand Down Expand Up @@ -1523,7 +1536,7 @@ Evaluate an integer flag and return an explanation
@tparam context context An opaque context object from @{makeUser} or @{makeContext}
@tparam string key The key of the flag to evaluate.
@tparam int fallback The value to return on error
@treturn table The evaluation explanation
@return @{EvaluationDetail}
*/
static int
LuaLDClientIntVariationDetail(lua_State *const l)
Expand Down Expand Up @@ -1587,7 +1600,7 @@ Evaluate a double flag and return an explanation
@tparam context context An opaque context object from @{makeUser} or @{makeContext}
@tparam string key The key of the flag to evaluate.
@tparam number fallback The value to return on error
@treturn table The evaluation explanation
@return @{EvaluationDetail}
*/
static int
LuaLDClientDoubleVariationDetail(lua_State *const l)
Expand Down Expand Up @@ -1654,7 +1667,7 @@ Evaluate a string flag and return an explanation
@tparam context context An opaque context object from @{makeUser} or @{makeContext}
@tparam string key The key of the flag to evaluate.
@tparam string fallback The value to return on error
@treturn table The evaluation explanation
@return @{EvaluationDetail}
*/
static int
LuaLDClientStringVariationDetail(lua_State *const l)
Expand Down Expand Up @@ -1724,7 +1737,7 @@ Evaluate a json flag and return an explanation
@tparam context context An opaque context object from @{makeUser} or @{makeContext}
@tparam string key The key of the flag to evaluate.
@tparam table fallback The value to return on error
@treturn table The evaluation explanation
@return @{EvaluationDetail}
*/
static int
LuaLDClientJSONVariationDetail(lua_State *const l)
Expand Down
2 changes: 1 addition & 1 deletion scripts/build-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ mkdir "$DOCS_BUILD_DIR"
cp launchdarkly-server-sdk.c "$DOCS_BUILD_DIR"
cp launchdarkly-server-sdk-redis.c "$DOCS_BUILD_DIR"

ldoc -d "$DOCS_RELEASE_DIR" "$DOCS_BUILD_DIR"
ldoc -d "$DOCS_RELEASE_DIR" "$DOCS_BUILD_DIR" -p "LaunchDarkly Lua Server SDK"