(+semver: patch) Add documentation #10
Open
+54
−1
Conversation
This file contains 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
Signed-off-by: Joshua Benjamin <[email protected]>
annymsMthd
requested review from
dkaminski,
thzinc,
cuevaskoch,
glenwperry,
k-grant and
StephenBondor
cuevaskoch
reviewed
Dec 9, 2019
| Proto Schema Registry provides a service to store proto schemas in kafka. It also supports breaking change detection and versioning. | ||
| Protobuf generated code is both backwards and forward compatible but this service provides a means for other services that don't have | ||
| the generated protobuf objects the ability to decode and display messages. |
There was a problem hiding this comment.
Compile-time vs. run-time is implied here, but newcomers to the project might understand the README more quickly if you called it out explicitly
cuevaskoch
reviewed
Dec 9, 2019
| Check out the [Protobuf Definition](docs/protos/proto/schema/registry/v1/registry_api.proto). | ||
|
|
||
| Once the service is up and running use the `RegisterSchema` grpc method to register a schema. The schema must be gzipped in the message. |
There was a problem hiding this comment.
This might be better as a list than a paragraph, can you list all three services along with use case?
cuevaskoch
suggested changes
Dec 9, 2019
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.
Signed-off-by: Joshua Benjamin [email protected]