This repository was archived by the owner on Jan 21, 2020. It is now read-only.
Introduce types.Any
to be used in place of json.RawMessage
#363
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.
This PR introduces a common type
Any
that models any user-defined / opaque structures in the input configuration.Currently when a plugin defines its custom input, a
Spec
, this code pattern is used:To provide better typing and a common abstraction (and not be so tightly coupled with JSON), the new pattern, including the
plugin.Name
introduced in #362, now look like:Any
has simple utility functions that help avoid boilerplatejson.Marshal/Unmarshal
code everywhere.Any
is currently typed aliased tojson.RawMessage
but this can be changed in the future without impacting code.Any
is similar in concept to the typeAny
in protobuf3.Spec
to useAny
.Any
for configuration.This PR does not change the plugin SPI where the use of
json.RawMessage
appears in methods likeValidate
. I'd like to propose that these be converted to useAny
by v1.0.