From 681f38a57b1efede19ef8f1b834bf6aaa507fddd Mon Sep 17 00:00:00 2001 From: Todd Baert Date: Fri, 3 May 2024 09:39:37 -0400 Subject: [PATCH] chore: add glossary entry for client object (#256) I've been missing this glossary entry for some recent content. --------- Signed-off-by: Todd Baert Co-authored-by: Michael Beemer --- specification/appendix-b-gherkin-suites.md | 2 +- specification/glossary.md | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/specification/appendix-b-gherkin-suites.md b/specification/appendix-b-gherkin-suites.md index 3aeb49ce..2e046dd4 100644 --- a/specification/appendix-b-gherkin-suites.md +++ b/specification/appendix-b-gherkin-suites.md @@ -9,7 +9,7 @@ sidebar_position: 5 This section contains a set of language-agnostic end-to-end tests (defined in gherkin). These tests can be used to validate the behavior of an OpenFeature implementation. -"Features" (test suites) can be used in conjunction with a cucumber test-runner for the language in question. +"Features" (test suites) can be used in conjunction with an [in-memory provider](./appendix-a-included-utilities.md#in-memory-provider) and a cucumber test-runner for the language in question. ## Evaluation Feature diff --git a/specification/glossary.md b/specification/glossary.md index d5187460..70ff2311 100644 --- a/specification/glossary.md +++ b/specification/glossary.md @@ -27,6 +27,7 @@ This document defines some terms that are used across this specification. - [Feature Flag API](#feature-flag-api) - [Evaluation API](#evaluation-api) - [Flag Management System](#flag-management-system) + - [Client](#client) - [Provider](#provider) - [Provider Lifecycle](#provider-lifecycle) - [Domain](#domain) @@ -106,6 +107,10 @@ The subset of the [Feature Flag API](#feature-flag-api) that the Application Aut A source-of-truth for flag values and rules. Flag management systems may include SaaS feature flag vendors, custom "in-house" feature flag infrastructure, or open-source implementations. +### Client + +A lightweight abstraction that provides functions to evaluate feature flags. A client is associated with a single provider, which it uses to perform evaluations. + ### Provider An SDK-compliant implementation which resolves flag values from a particular flag management system, allowing the use of the [Evaluation API](./sections/01-flag-evaluation.md#13-flag-evaluation) as an abstraction for the system in question.