Add Barber API protos to support more dynamic functionality #51
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
adrw
force-pushed
the
adrw/20201005.addBarberProtoApi
branch
from
62e19ea
to
a7ef3a3
Compare
ejao1
reviewed
Oct 5, 2020
| */ | ||
| optional string template_token = 1; | ||
| /* The context values required to render a DocumentTemplate of the given template_id */ | ||
| repeated Field fields = 2; |
There was a problem hiding this comment.
Nit: Do we have an internal guideline on whether repeated field names should have the trailing "s"?
There was a problem hiding this comment.
I don't think so but I'll defer to @swankjesse or others if they have opinions
swankjesse
approved these changes
Oct 5, 2020
| */ | ||
| optional string template_token = 1; | ||
| /* The context values required to render a DocumentTemplate of the given template_id */ | ||
| repeated Field fields = 2; |
| /* A unique identifier used for lookup */ | ||
| optional string template_token = 1; | ||
| /* An auto-incrementing integer to identify a unique version of the same DocumentTemplate */ | ||
| optional int64 version = 2; |
There was a problem hiding this comment.
It will be used by a CMS service soon so adding it now in advance
| /* An auto-incrementing integer to identify a unique version of the same DocumentTemplate */ | ||
| optional int64 version = 2; | ||
| /* Locale language that the DocumentTemplate is written in */ | ||
| optional string locale = 3; |
There was a problem hiding this comment.
For formality, wanna specify that this is an RFC 5646 language tag?
https://tools.ietf.org/html/rfc5646#appendix-A
There was a problem hiding this comment.
(or whatever spec this interlocks with on the other side)
adrw
force-pushed
the
adrw/20201005.addBarberProtoApi
branch
from
a7ef3a3
to
6863d8c
Compare
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.
Proto versions of
DocumentDataandDocumentTemplatewill provide for easier usage of Barber within APIs and events that can leverage Wire for over-the-wire encoding.Notably,
Documentwill remain as a non-proto implemented Kotlin data class in order to provide more precise configuration of per field output encoding using@BarberFieldannotations.