Skip to content

feat: Client provider guidelines #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
thomaspoignant merged 47 commits into from
May 16, 2025
Merged

feat: Client provider guidelines #14

thomaspoignant merged 47 commits into from
May 16, 2025

Conversation

@thomaspoignant
Copy link
Member

@thomaspoignant thomaspoignant commented Apr 30, 2024 •
edited
Loading

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

@thomaspoignant thomaspoignant requested a review from a team as a code owner April 30, 2024 21:41
markphelps
markphelps reviewed May 1, 2024
View reviewed changes
Copy link
Contributor

@markphelps markphelps left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

couple minor typos/grammar suggestions

beeme1mr
beeme1mr reviewed May 1, 2024
View reviewed changes
Copy link
Member

@beeme1mr beeme1mr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Kavindu-Dodan
Kavindu-Dodan reviewed May 1, 2024
View reviewed changes
Kavindu-Dodan
Kavindu-Dodan reviewed May 1, 2024
View reviewed changes
Copy link
Contributor

@Kavindu-Dodan Kavindu-Dodan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 thomaspoignant force-pushed the client-spec branch 2 times, most recently from 623950c to 5c18eb8 Compare May 2, 2024 21:18
@thomaspoignant
Copy link
Member Author

thomaspoignant commented May 2, 2024

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
Copy link
Contributor

Kavindu-Dodan commented May 3, 2024 •
edited
Loading

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
Kavindu-Dodan approved these changes May 13, 2024
View reviewed changes
Copy link
Contributor

@Kavindu-Dodan Kavindu-Dodan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@thomaspoignant thomaspoignant changed the title feat: Client provider spec feat: Client provider guidelines May 14, 2024
beeme1mr
beeme1mr reviewed May 15, 2024
View reviewed changes
lukas-reining
lukas-reining reviewed May 15, 2024
View reviewed changes
Copy link
Member

@lukas-reining lukas-reining left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

nicklasl
nicklasl reviewed May 17, 2024
View reviewed changes
@thomaspoignant thomaspoignant force-pushed the client-spec branch 2 times, most recently from ed3ac70 to 961f3c7 Compare May 17, 2024 17:09
@Kavindu-Dodan Kavindu-Dodan self-requested a review May 17, 2024 21:26
Kavindu-Dodan
Kavindu-Dodan reviewed May 17, 2024
View reviewed changes
@thomaspoignant thomaspoignant mentioned this pull request May 8, 2025
Open
@thomaspoignant
Copy link
Member Author

thomaspoignant commented May 8, 2025

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

cc @beeme1mr @lukas-reining @jonathannorris @askpt

@thomaspoignant thomaspoignant force-pushed the client-spec branch 2 times, most recently from 6500624 to d8563eb Compare May 8, 2025 10:55
askpt
askpt approved these changes May 8, 2025
View reviewed changes
Copy link
Member

@askpt askpt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Just a small suggestion but non-blocker.

lukas-reining
lukas-reining reviewed May 9, 2025
View reviewed changes
Copy link
Member

@lukas-reining lukas-reining left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

thomaspoignant and others added 25 commits May 16, 2025 18:37
@thomaspoignant @beeme1mr
Update guideline/static-context-provider.md
f7ae6f6 
Co-authored-by: Michael Beemer <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant @lukas-reining
Update guideline/static-context-provider.md
2ee1334 
Co-authored-by: Lukas Reining <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant @lukas-reining
Update guideline/static-context-provider.md
93ae648 
Co-authored-by: Lukas Reining <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant
update guidelines after removing configuration endpoint
9c0d58e 
Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant
adding change context
74ea709 
Signed-off-by: Thomas Poignant <[email protected]>
@grimly @thomaspoignant
feat: Allow any reason (#20)
b8a9ade 
Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant
feat!: change minPollingInterval field name to mention millisecond (#25)
581661a 
* feat!: change minPollingInterval field name to mention millisecond

Signed-off-by: Thomas Poignant <[email protected]>

* change name to ms

Signed-off-by: Thomas Poignant <[email protected]>

---------

Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant
feat: Group API in core and extensions (#23)
cf58be9 
Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant
feat!: Reverse the logic for supportedTypes (#24)
451caac 
* feat!: Reverse the logic for supportedTypes

Signed-off-by: Thomas Poignant <[email protected]>

* fix

Signed-off-by: Thomas Poignant <[email protected]>

---------

Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant
doc: adding providers link (#26)
d87f64b 
Signed-off-by: Thomas Poignant <[email protected]>
@Kavindu-Dodan @thomaspoignant
make flags property mandatory for bulk evaluation success response (#27)
87cbb1a 
Signed-off-by: Kavindu Dodanduwa <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant
feat: Typo in header name (#28)
e8a0ba1 
Signed-off-by: Thomas Poignant <[email protected]>
@beeme1mr @thomaspoignant
add optional targeting key property (#30)
dcb3fd3 
Signed-off-by: Michael Beemer <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
@erka @thomaspoignant
fix: use correct header name for 429 bulk response (#32)
fef9043 
Signed-off-by: Roman Dmytrenko <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant @Kavindu-Dodan @toddbaert
feat: Specify caching for OFREP in server providers (#17)
327d3cc 
Signed-off-by: Thomas Poignant <[email protected]>
Signed-off-by: Kavindu Dodanduwa <[email protected]>
Co-authored-by: Kavindu Dodanduwa <[email protected]>
Co-authored-by: Todd Baert <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
@toddbaert @thomaspoignant
feat: add flag set metadata for bulk response and failures (#34)
9ca3e26 
Signed-off-by: Todd Baert <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
@czechboy0 @thomaspoignant
Fixups: Add operationIds, remove invalid property, fix tag casing (#35)
0900b18 
Signed-off-by: Honza Dvorsky <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
@beeme1mr @thomaspoignant
ci: switch OpenAPI validators (#36)
f610bf7 
Signed-off-by: Michael Beemer <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant
fix: address style issues
ec48b76 
Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant @lukas-reining
Update static-context-provider.md
93b2bec 
Co-authored-by: Lukas Reining <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant @lukas-reining
Update static-context-provider.md
b443840 
Co-authored-by: Lukas Reining <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant
adding timeout
3f5fbf7 
Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant
feat: Server provider guidelines (#42)
b8fe901 
* feat: Server provider guideline

Signed-off-by: Thomas Poignant <[email protected]>

* adding timeout

Signed-off-by: Thomas Poignant <[email protected]>

---------

Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant
feat: Group API in core and extensions (#23)
ac41c3c 
Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant @beeme1mr
Update guideline/static-context-provider.md
07df226 
Co-authored-by: Michael Beemer <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant
Merge branch 'main' into client-spec
b6f6957 
Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant
Update openapi.yaml
2502795 
Signed-off-by: Thomas Poignant <[email protected]>
@thomaspoignant thomaspoignant merged commit 66f2683 into main May 16, 2025
4 checks passed
@thomaspoignant thomaspoignant deleted the client-spec branch May 16, 2025 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@beeme1mr beeme1mr beeme1mr approved these changes

@nicklasl nicklasl nicklasl left review comments

@lukas-reining lukas-reining lukas-reining approved these changes

@askpt askpt Awaiting requested review from askpt

+2 more reviewers

@markphelps markphelps markphelps left review comments

@Kavindu-Dodan Kavindu-Dodan Kavindu-Dodan approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.