feat: Server provider guidelines #42
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thomaspoignant
changed the title
thomaspoignant
requested review from
askpt,
beeme1mr,
jonathannorris and
lukas-reining
thomaspoignant
force-pushed
the
server-guideline
branch
from
0a90d31 to
057645c
Compare
askpt
reviewed
May 8, 2025
Member
askpt
left a comment
askpt
left a comment
There was a problem hiding this comment.
Small comment, otherwise looks good.
Member
lukas-reining
left a comment
lukas-reining
left a comment
There was a problem hiding this comment.
This is great, the feedback from the client provider applies here too @thomaspoignant :)
Signed-off-by: Thomas Poignant <[email protected]>
thomaspoignant
force-pushed
the
server-guideline
branch
from
057645c to
e5fee69
Compare
Member
Author
|
@lukas-reining I have adapted the same changes to the server provider guideline. |
askpt
approved these changes
May 9, 2025
lukas-reining
approved these changes
May 9, 2025
beeme1mr
approved these changes
May 9, 2025
Member
beeme1mr
left a comment
beeme1mr
left a comment
There was a problem hiding this comment.
We may want to briefly mention http timeout behavior. In the web provider I believe we default to 10 seconds and the provider is put in an error state.
It may also be worth briefly describing the expected behavior if the response is invalid. I would expect a provider error if it occurs during initialization. If the provider receives an unexpected response after initialization I would expect the provider to use the previously cached value and possibly emit an error event.
Member
Author
Yes mentioning the timeout is a good idea I will add it.
There is no caching in the server provider so I am not sure what you mean here? |
Signed-off-by: Thomas Poignant <[email protected]>
thomaspoignant
force-pushed
the
server-guideline
branch
from
e5a556e to
e9f39cb
Compare
thomaspoignant
added a commit
that referenced
this pull request
May 12, 2025
* 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
added a commit
that referenced
this pull request
May 16, 2025
* 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
added a commit
that referenced
this pull request
May 16, 2025
* feat: Client provider spec Signed-off-by: Thomas Poignant <[email protected]> * Update provider/specs/client.md Co-authored-by: Mark Phelps <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * Update provider/specs/client.md Co-authored-by: Mark Phelps <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * Update provider/specs/client.md Co-authored-by: Michael Beemer <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * Update provider/specs/client.md Co-authored-by: Mark Phelps <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * Update provider/specs/client.md Co-authored-by: Mark Phelps <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * Update provider/specs/client.md Co-authored-by: Mark Phelps <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * Update provider/specs/client.md Co-authored-by: Mark Phelps <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * Update provider/specs/client.md Co-authored-by: Mark Phelps <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * Update provider/specs/client.md Co-authored-by: Mark Phelps <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * Update provider/specs/client.md Co-authored-by: Mark Phelps <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * Update provider/specs/client.md Co-authored-by: Mark Phelps <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * Update provider/specs/client.md Co-authored-by: Mark Phelps <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * Update provider/specs/client.md Co-authored-by: Michael Beemer <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * Update provider/specs/client.md Co-authored-by: Michael Beemer <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * update with review comments Signed-off-by: Thomas Poignant <[email protected]> * Move to guideline folder Signed-off-by: Thomas Poignant <[email protected]> * Replace specification Signed-off-by: Thomas Poignant <[email protected]> * add OpenAPI spec validator based on redocly cli (#15) Signed-off-by: Kavindu Dodanduwa <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * chore(deps): update actions/checkout action to v4 (#16) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Signed-off-by: Thomas Poignant <[email protected]> * Update guideline/static-context-provider.md Co-authored-by: Michael Beemer <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * Update guideline/static-context-provider.md Co-authored-by: Lukas Reining <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * Update guideline/static-context-provider.md Co-authored-by: Lukas Reining <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * update guidelines after removing configuration endpoint Signed-off-by: Thomas Poignant <[email protected]> * adding change context Signed-off-by: Thomas Poignant <[email protected]> * feat: Allow any reason (#20) Signed-off-by: Thomas Poignant <[email protected]> * feat!: change minPollingInterval field name to mention millisecond (#25) * 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]> * feat: Group API in core and extensions (#23) Signed-off-by: Thomas Poignant <[email protected]> * feat!: Reverse the logic for supportedTypes (#24) * 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]> * doc: adding providers link (#26) Signed-off-by: Thomas Poignant <[email protected]> * make flags property mandatory for bulk evaluation success response (#27) Signed-off-by: Kavindu Dodanduwa <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * feat: Typo in header name (#28) Signed-off-by: Thomas Poignant <[email protected]> * add optional targeting key property (#30) Signed-off-by: Michael Beemer <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * fix: use correct header name for 429 bulk response (#32) Signed-off-by: Roman Dmytrenko <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * feat: Specify caching for OFREP in server providers (#17) 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]> * feat: add flag set metadata for bulk response and failures (#34) Signed-off-by: Todd Baert <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * Fixups: Add operationIds, remove invalid property, fix tag casing (#35) Signed-off-by: Honza Dvorsky <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * ci: switch OpenAPI validators (#36) Signed-off-by: Michael Beemer <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * fix: address style issues Signed-off-by: Thomas Poignant <[email protected]> * Update static-context-provider.md Co-authored-by: Lukas Reining <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * Update static-context-provider.md Co-authored-by: Lukas Reining <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * adding timeout Signed-off-by: Thomas Poignant <[email protected]> * feat: Server provider guidelines (#42) * 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]> * feat: Group API in core and extensions (#23) Signed-off-by: Thomas Poignant <[email protected]> * Update guideline/static-context-provider.md Co-authored-by: Michael Beemer <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> * Update openapi.yaml Signed-off-by: Thomas Poignant <[email protected]> --------- Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Thomas Poignant <[email protected]> Signed-off-by: Kavindu Dodanduwa <[email protected]> Signed-off-by: Michael Beemer <[email protected]> Signed-off-by: Roman Dmytrenko <[email protected]> Signed-off-by: Kavindu Dodanduwa <[email protected]> Signed-off-by: Todd Baert <[email protected]> Signed-off-by: Honza Dvorsky <[email protected]> Co-authored-by: Mark Phelps <[email protected]> Co-authored-by: Michael Beemer <[email protected]> Co-authored-by: Kavindu Dodanduwa <[email protected]> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Lukas Reining <[email protected]> Co-authored-by: Michel TURPIN <[email protected]> Co-authored-by: Roman Dmytrenko <[email protected]> Co-authored-by: Todd Baert <[email protected]> Co-authored-by: Honza Dvorsky <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR
This PR contains the guidelines on how to create a server provider for OFREP.
Closes #41