Skip to content

Commit

Permalink
docs: PR fixes
Browse files Browse the repository at this point in the history
Co-authored-by: Todd Baert <[email protected]>
Co-authored-by: Michael Beemer <[email protected]>
Signed-off-by: Max VelDink <[email protected]>
  • Loading branch information
3 people authored Feb 28, 2024
1 parent 828af47 commit bbd2749
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion specification/sections/01-flag-evaluation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"}]
Expand Down
4 changes: 2 additions & 2 deletions specification/sections/02-providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions specification/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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

Expand Down

0 comments on commit bbd2749

Please sign in to comment.