Yaml plugin addition #82
Conversation
|
Good stuff, I think this is actually very valuable and we could use it in our kube work. The changes requested are minimal. A bigger question we need to answer is if it should actually work exactly as the json plug-in, same parameters, same behavior, bean (un)marshalling, etc. Or do we pick and choose? Because ultimately yaml is a superset of json |
src/main/java/com/datasonnet/plugins/DefaultYamlFormatPlugin.java
Outdated
Show resolved
Hide resolved
|
|
||
| try { | ||
| Object inputAsJava = ujsonUtils.javaObjectFrom(input); | ||
| ObjectMapper yamlMapper = new ObjectMapper(new YAMLFactory()); |
There was a problem hiding this comment.
Changed this one to ObjectMapper yamlMapper = new ObjectMapper(DEFAULT_YAML_FACTORY); not sure if you wanted a third constant for an object mapper initialized with the yaml factory
| StringBuilder value = null; | ||
|
|
||
| //if instance of list, it is multiple docs in one. | ||
| if(inputAsJava instanceof List){ |
There was a problem hiding this comment.
We'll need a writer parameter to tell us what to do here. Something like arrayAsMultiDoc
There was a problem hiding this comment.
What would we do instead in this case?
im assuming if arrayAsMultiDoc is false it would do something else, but what else could it do while still being valid yaml?
There was a problem hiding this comment.
It would come out as a single doc that's an array in YAML, those are legal top-levels, just like in JSON (some JSON processors restrict that, but the spec definitely allows it)
|
|
||
| public class DefaultYamlFormatPlugin extends BaseJacksonDataFormatPlugin { | ||
|
|
||
| public static final String DS_PARAM_YAML_HEADER = "removehead"; |
There was a problem hiding this comment.
Is header the official / accurate term in yaml?
There was a problem hiding this comment.
Not really, it doesnt have a name for it: https://yaml.org/spec/1.1/#id857577
There was a problem hiding this comment.
If you click the three dashes, they have a name in that section, Document Boundary Markers
|
@JakeMHughes I made a couple comments (not in a review) above, but agreed with @jam01 this is good stuff we want to include once we've fixed a few things |
This PR adds the YAML plugin which can be accessed using
application/yamlSince yaml is becoming used in more & more configuration files. This would be useful for validating and transforming said configurations (OASv3 and K8s are good examples) .This plugin supports Reading & writing both single Yaml documents as well as multiple documents. i.e.
If only a single document is passed, you access the contents like its a json object, like:
payload.message. Single documents also have the option to disable the yaml head( the---line) with the optionRemoveHead=trueIf a multi document is passed, you access the contents like its a json array, like:
payload[0].messageBoth types have access to the
DisableQuotes=trueheader which will remove quotes from the strings