From bbd27498cddc74aa7052adcad80397aeae483011 Mon Sep 17 00:00:00 2001 From: Max VelDink Date: Wed, 28 Feb 2024 06:00:13 -0500 Subject: [PATCH] docs: PR fixes Co-authored-by: Todd Baert Co-authored-by: Michael Beemer Signed-off-by: Max VelDink --- specification/sections/01-flag-evaluation.md | 2 +- specification/sections/02-providers.md | 4 ++-- specification/types.md | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/specification/sections/01-flag-evaluation.md b/specification/sections/01-flag-evaluation.md index 3d229519..56dc36ea 100644 --- a/specification/sections/01-flag-evaluation.md +++ b/specification/sections/01-flag-evaluation.md @@ -173,7 +173,7 @@ For backwards compatibility, implementations should consider `name` an alias to #### Requirement 1.2.3 -> The client interface **MUST** define a `allFlagMetadata` member or accessor, returning a collection of flag metadata from the provider. +> The client interface **MUST** define a `all flag metadata` member or accessor, returning a collection of flag metadata from the provider. ```typescript client.getAllFlagMetadata() // [{"key": "featureA", "type": "boolean"}, {"key": "featureB", "type": "string"}] diff --git a/specification/sections/02-providers.md b/specification/sections/02-providers.md index 5e0522f6..4508df5b 100644 --- a/specification/sections/02-providers.md +++ b/specification/sections/02-providers.md @@ -28,13 +28,13 @@ provider.getMetadata().getName(); // "my-custom-provider" #### Requirement 2.1.2 -> The provider **MAY** define an `allFlagMetadata` field or accessor of type collection of flag_metadata, which identifies all available flag keys in the provider. +> The provider **MAY** define an `all flag metadata` field or accessor of type collection of flag_metadata, which identifies all available flag keys in the provider. ```typescript provider.getAllFlagMetadata(); // [{"key": "featureA", "type": "boolean"}, {"key": "featureB", "type": "string"}] ``` -This operation should not be confused with bulk evaluation of all flags. +This operation should not be confused with a bulk evaluation of all flags. This is an informative operation available to clients for understanding which flag keys are currently active from a provider. Example usages include building a debug screen based on available flags and detecting stale flag evaluations. For some providers, fetching all flags is an expensive operation. If there is language support, consider implementing this as an asynchronous operation. diff --git a/specification/types.md b/specification/types.md index 23619ed1..e8a41228 100644 --- a/specification/types.md +++ b/specification/types.md @@ -127,8 +127,8 @@ A structure containing the following fields: A structure which supports definition of arbitrary properties, with keys of type `string`, and values of type `boolean`, `string`, or `number`. -`key` is a required property with a value of `string`. -`type` is an optional property with a `string` value indicating which client resolution method should be used to resolve the flag key. +`key` is a required property with a value of type `string`. +`type` is an optional property with a value of type `string`, indicating which client resolution method should be used to resolve the flag key. This structure is populated by a provider for use by an [Application Author](./glossary.md#application-author) via the [Evaluation API](./glossary.md#evaluation-api) or an [Application Integrator](./glossary.md#application-integrator) via [hooks](./sections/04-hooks.md). @@ -137,7 +137,7 @@ This structure is populated by a provider for use by an [Application Author](./g A structure which carries information about the provider. In addition to the defined metadata fields below, arbitrary information can be stored here unique to the provider. -`name` is a required key with a string value. +`name` is a required key with a value of type string. ### Provider Status