Updating kafka schema and docs to provide better details #885
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
bsquizz
force-pushed
the
update_kafka_docs
branch
from
7f3b30e
to
32d39a9
Compare
bsquizz
commented
Nov 1, 2023
docs/appconfig/schema-definitions-dependencyendpoint-properties-apipath.md
Show resolved
Hide resolved
psav
approved these changes
Nov 2, 2023
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.
The kafka docs are a bit out of date, especially since ADR-20. Some people were confused on what values they can expect to see in the cdappconfig, so the new examples here hopefully clear it up. Also I updated the schema to provide better descriptions. Tried to use enums but that ended up resulting in the code generator creating new types for the fields instead of sticking with
*string... I want to avoid code breakage so just updating thedescriptionto indicate what values people can expect the fields to be set to by Clowder.