feat: add presetRef to observation
#207
Merged
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
gmaclennan
requested changes
Aug 5, 2024
There was a problem hiding this comment.
I think we should leave presetRef as optional. I think there are cases where it might not make sense to populate this value (an observation could be created without a preset - it is in tests).
I think for Protobuf sub-messages, the difference between marking it as optional or not is in the generated code and resulting types either being { presetRef?: PresetRef | undefined } or { presetRef: PresetRef | undefined }. I think the former is preferable, to avoid the API consumer needing to always specify it as a property, even if undefined. So maybe add optional to the proto def too.
Can you ensure test fixtures include docs both with and without the presetRef set.
gmaclennan
requested changes
Aug 5, 2024
Co-authored-by: Gregor MacLennan <gmaclennan@digital-democracy.org>
This was referenced Aug 24, 2024
This was referenced Sep 2, 2024
This was referenced Sep 16, 2024
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.
should close #205. I put it as required on JSONSchema and non-optional on the proto definition