feat: Client provider guidelines by thomaspoignant · Pull Request #14 · open-feature/protocol

thomaspoignant · 2024-04-30T21:41:18Z

This PR is a first draft for a provider client spec.

Please provide feedback on this one to know if I am heading in the right direction and to know if it can be helpful to create providers.

Those are the guidelines related to the issue #11

markphelps

couple minor typos/grammar suggestions

provider/specs/client.md

beeme1mr

Great start, thanks! I added a few suggestions but I think this will be helpful.

We may want to avoid calling it a spec (at least for now). I would recommend calling it a guideline.

provider/specs/client.md

Kavindu-Dodan

Thanks @thomaspoignant for getting started on this 🙌

I have following general remarks,

Language - Given this is a spec and to be similar to OF Spec, I think we should generilize langauge to avoid "we" usage (ex:- In this specification we will specify.. to This specificaiton specify..)
Spec name & title - Given this is specific to client side (aka static context), a good name for file could be client-provider/ static-context-provider

Otherwise I think this is a great first step

thomaspoignant · 2024-05-02T21:22:57Z

Thanks @thomaspoignant for getting started on this 🙌

I have following general remarks,

* Language - Given this is a spec and to be similar to OF Spec, I think we should generilize langauge to avoid "we" usage (ex:- `In this specification we will specify..` to `This specificaiton specify..`)

* Spec name & title - Given this is specific to client side (aka static context), a good name for file could be `client-provider`/ `static-context-provider`

Otherwise I think this is a great first step

I have renamed the file and stopped using the term specification to avoid any confusion here.
Do you think we should continue to update the language if it is only a guideline?

Kavindu-Dodan · 2024-05-03T21:15:53Z

I have renamed the file and stopped using the term specification to avoid any confusion here.

Thanks :)

Do you think we should continue to update the language if it is only a guideline?

Yeah, can start simple and then convert this to a spec. So let's not spend too much time on this.

Kavindu-Dodan

I am happy with this so we can get started :)

guideline/static-context-provider.md

lukas-reining

Nice start and it is really valuable to have!
I left some comments, and I would generally tent to describe the expected behavior of the provider in third person instead of using first person developer.

guideline/static-context-provider.md

.github/workflows/spec-validate.yaml

thomaspoignant · 2025-05-08T10:21:06Z

I have updated the guidelines with deleting the /ofrep/v1/endpoint.
I'll be interested in any review.

cc @beeme1mr @lukas-reining @jonathannorris @askpt

askpt

LGTM! Just a small suggestion but non-blocker.

guideline/static-context-provider.md

lukas-reining

This is good @thomaspoignant! Left some comments related to wording/style.

guideline/static-context-provider.md

Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com> Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Co-authored-by: Lukas Reining <lukas.reining@codecentric.de> Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* feat!: change minPollingInterval field name to mention millisecond Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org> * change name to ms Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org> --------- Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* feat!: Reverse the logic for supportedTypes Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org> * fix Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org> --------- Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Signed-off-by: Kavindu Dodanduwa <kavindudodanduwa@gmail.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Signed-off-by: Roman Dmytrenko <rdmytrenko@gmail.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org> Signed-off-by: Kavindu Dodanduwa <Kavindu-Dodan@users.noreply.github.com> Co-authored-by: Kavindu Dodanduwa <Kavindu-Dodan@users.noreply.github.com> Co-authored-by: Todd Baert <todd.baert@dynatrace.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Signed-off-by: Todd Baert <todd.baert@dynatrace.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Signed-off-by: Honza Dvorsky <honza@apple.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Co-authored-by: Lukas Reining <lukas.reining@codecentric.de> Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* feat: Server provider guideline Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org> * adding timeout Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org> --------- Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com> Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

thomaspoignant requested a review from a team as a code owner April 30, 2024 21:41

thomaspoignant requested review from Kavindu-Dodan, beeme1mr and lukas-reining April 30, 2024 21:45

markphelps reviewed May 1, 2024

View reviewed changes

beeme1mr reviewed May 1, 2024

View reviewed changes

Kavindu-Dodan reviewed May 1, 2024

View reviewed changes

provider/specs/client.md Outdated Show resolved Hide resolved

Kavindu-Dodan reviewed May 1, 2024

View reviewed changes

thomaspoignant force-pushed the client-spec branch 2 times, most recently from 623950c to 5c18eb8 Compare May 2, 2024 21:18

Kavindu-Dodan approved these changes May 13, 2024

View reviewed changes

thomaspoignant changed the title ~~feat: Client provider spec~~ feat: Client provider guidelines May 14, 2024

beeme1mr reviewed May 15, 2024

View reviewed changes

guideline/static-context-provider.md Outdated Show resolved Hide resolved

guideline/static-context-provider.md Outdated Show resolved Hide resolved

guideline/static-context-provider.md Outdated Show resolved Hide resolved

lukas-reining reviewed May 15, 2024

View reviewed changes

nicklasl reviewed May 17, 2024

View reviewed changes

guideline/static-context-provider.md Show resolved Hide resolved

thomaspoignant force-pushed the client-spec branch 2 times, most recently from ed3ac70 to 961f3c7 Compare May 17, 2024 17:09

Kavindu-Dodan self-requested a review May 17, 2024 21:26

Kavindu-Dodan reviewed May 17, 2024

View reviewed changes

.github/workflows/spec-validate.yaml Show resolved Hide resolved

thomaspoignant mentioned this pull request May 8, 2025

OFREP 1.0 roadmap #39

Open

thomaspoignant force-pushed the client-spec branch from b0cf315 to 4fd0419 Compare May 8, 2025 10:20

thomaspoignant force-pushed the client-spec branch 2 times, most recently from 6500624 to d8563eb Compare May 8, 2025 10:55

askpt approved these changes May 8, 2025

View reviewed changes

guideline/static-context-provider.md Outdated Show resolved Hide resolved

lukas-reining reviewed May 9, 2025

View reviewed changes

thomaspoignant force-pushed the client-spec branch from 3952114 to 2081bef Compare May 9, 2025 08:44

thomaspoignant requested a review from lukas-reining May 9, 2025 08:45

thomaspoignant and others added 25 commits May 16, 2025 18:37

Update guideline/static-context-provider.md

f7ae6f6

Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com> Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Update guideline/static-context-provider.md

2ee1334

Co-authored-by: Lukas Reining <lukas.reining@codecentric.de> Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Update guideline/static-context-provider.md

93ae648

Co-authored-by: Lukas Reining <lukas.reining@codecentric.de> Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

update guidelines after removing configuration endpoint

9c0d58e

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

adding change context

74ea709

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

feat: Allow any reason (#20)

b8a9ade

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

feat: Group API in core and extensions (#23)

cf58be9

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

doc: adding providers link (#26)

d87f64b

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

make flags property mandatory for bulk evaluation success response (#27)

87cbb1a

Signed-off-by: Kavindu Dodanduwa <kavindudodanduwa@gmail.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

feat: Typo in header name (#28)

e8a0ba1

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

add optional targeting key property (#30)

dcb3fd3

Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

fix: use correct header name for 429 bulk response (#32)

fef9043

Signed-off-by: Roman Dmytrenko <rdmytrenko@gmail.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

feat: add flag set metadata for bulk response and failures (#34)

9ca3e26

Signed-off-by: Todd Baert <todd.baert@dynatrace.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Fixups: Add operationIds, remove invalid property, fix tag casing (#35)

0900b18

Signed-off-by: Honza Dvorsky <honza@apple.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

ci: switch OpenAPI validators (#36)

f610bf7

Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

fix: address style issues

ec48b76

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Update static-context-provider.md

93b2bec

Co-authored-by: Lukas Reining <lukas.reining@codecentric.de> Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Update static-context-provider.md

b443840

Co-authored-by: Lukas Reining <lukas.reining@codecentric.de> Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

adding timeout

3f5fbf7

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

feat: Group API in core and extensions (#23)

ac41c3c

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Update guideline/static-context-provider.md

07df226

Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com> Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com> Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

thomaspoignant force-pushed the client-spec branch from 6a3cf9d to 07df226 Compare May 16, 2025 16:43

thomaspoignant added 2 commits May 16, 2025 18:44

Merge branch 'main' into client-spec

b6f6957

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Update openapi.yaml

2502795

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

thomaspoignant merged commit 66f2683 into main May 16, 2025
4 checks passed

thomaspoignant deleted the client-spec branch May 16, 2025 16:47

Conversation

thomaspoignant commented Apr 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

markphelps left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

beeme1mr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Kavindu-Dodan left a comment

Choose a reason for hiding this comment

Uh oh!

thomaspoignant commented May 2, 2024

Uh oh!

Kavindu-Dodan commented May 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Kavindu-Dodan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lukas-reining left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thomaspoignant commented May 8, 2025

Uh oh!

askpt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lukas-reining left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

thomaspoignant commented Apr 30, 2024 •

edited

Loading

Kavindu-Dodan commented May 3, 2024 •

edited

Loading