Skip to content
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

docs: Buf schema registry readme #34

Merged
merged 6 commits into from
Oct 21, 2022
Merged

docs: Buf schema registry readme #34

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
02945d2
updated event type
james-milligan Sep 28, 2022
b84d91c
Merge https://github.com/open-feature/schemas
james-milligan Oct 5, 2022
b0dc6dd
Merge branch 'open-feature:main' into main
james-milligan Oct 20, 2022
9209fef
added readme
james-milligan Oct 20, 2022
fa3fbfc
language updates
james-milligan Oct 20, 2022
31b6761
Update protobuf/buf.md
james-milligan Oct 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions protobuf/buf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Flagd build spec

## This repository is managed by OpenFeature

This module contains the core types that developers can use for interacting with [flagd](https://github.com/open-feature/flagd).

Internally flagd uses the connect protocol, meaning it is compatible with grpc interfaces. If your desired language has a supported plugin for generating connect stubs then it is reccomended to use these over grpc.

The package contains a single `Service`, describing the 5 core `rpcs` for feature flag evaluation (`ResolveBoolean`, `ResolveString`, `ResolveFloat`, `ResolveInt` and `ResolveObject`) each with their type specific request and response objects(`ResolveXXXRequest` and `ResolveXXXResponse`).
The final `rpc` on the `Service` is a streamed response named `EventStream`, this is used to pass internal events to the client, such as `configuration_change` and `provider_ready`.

## Build options

The core definitions are in the `schema.v1` package, and contains package name options for the following languages, as such these options may be excluded from build instructions:

- Go: schema/service/v1
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

while a table would be more suitable here, its formatting is lost in the schema registry

Copy link
Member

@toddbaert toddbaert Oct 20, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

What do you think about taking this chance to update the go package name?

I think I'd like to see something more like the other examples. This is a nitpick though, it won't block the merge from my end.

cc @skyerus

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We have another issue open for this here. I tihnk we should hold off on making this change until after kubecon, as it will change the import paths for flagd and the go provider.

- Java: dev.openfeature.flagd.grpc
- C#: OpenFeature.Flagd.Grpc