docs: clarify evaluation and resolution details#382
docs: clarify evaluation and resolution details#382Rul1an wants to merge 1 commit intoopen-feature:mainfrom
Conversation
6938df9 to
21ab40e
Compare
There was a problem hiding this comment.
Code Review
This pull request updates the specification/types.md file to clarify the roles of evaluation details and resolution details, ensuring a clear distinction between application-facing results and provider-to-SDK data structures. It also corrects terminology regarding flag evaluation functions. Feedback was provided to improve terminological precision, specifically to avoid ambiguity with the flag metadata field and to maintain consistency with existing specification terms like 'resolution details' and 'error information'.
There was a problem hiding this comment.
Pull request overview
Clarifies the distinction between evaluation details (application-facing output of detailed flag evaluation) and resolution details (provider-to-SDK result used to build evaluation details) in the OpenFeature specification docs.
Changes:
- Updates terminology to refer to “detailed flag evaluation functions” for the application-facing API.
- Adds a NOTE explaining
evaluation detailsas the application-facing result and how it relates toresolution details. - Expands the NOTE for
resolution detailsto describe the provider-to-SDK contract and how SDKs construct evaluation details.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Rul1an <roelschuurkes@gmail.com>
21ab40e to
a2580af
Compare
|
Small downstream context, no action needed here: this clarification around application-facing It stays outside OpenFeature and is framed as downstream use of the existing detailed evaluation surface, not as an integration, support, or partnership claim. Assay release: https://github.com/Rul1an/assay/releases/tag/v3.8.0 |
What changed
Clarifies the relationship between
evaluation detailsandresolution detailsinspecification/types.md.The update:
evaluation detailsas the application-facing result returned from detailed flag evaluationresolution detailsas the provider-to-SDK return shape used to build evaluation detailsWhy
The two structures share many fields, which can make it unclear why both exist. This adds a small docs clarification without changing any requirements or API behavior.
Fixes #168.
Validation
Ran locally: