Remove PSON document_type

19 views
Skip to first unread message

Erik Dalén

unread,
Sep 3, 2014, 7:32:12 AM9/3/14
to Puppet Developers
It would be nice to remove the document_type from the PSON hashes for Puppet 4. This would be a modification of the API though, so it is a backwards incompatible change. But it is data that AFAIK the agent throws away anyway when it receives it.

The benefit of doing this change is that the API would look the same for all serialisation formats, and a bunch of code for the PSON special handling could be removed. It should be completely backwards compatible for Puppet, but other consumers of the API might be affected.


Here is a example of code that adds this information to the API reply (there's a bunch of places that does this):

And here is the code that throws away that info:

What do you others think about doing that change?

--
Erik Dalén

Andy Parker

unread,
Sep 3, 2014, 2:00:42 PM9/3/14
to puppe...@googlegroups.com
I think that is pretty reasonable. The information can't be very important if puppet doesn't need it in any way. Does anyone know of any consumers of the puppet REST api that depend on this being there?
 
--
Erik Dalén

--
You received this message because you are subscribed to the Google Groups "Puppet Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to puppet-dev+...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/puppet-dev/CAAAzDLfKczVcG3LPLhFRSJhxB1hhxu%2B6jOQDT3w0uf3vD9p04w%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.



--
Andrew Parker
Freenode: zaphod42
Twitter: @aparker42
Software Developer

Join us at PuppetConf 2014, September 22-24 in San Francisco
Register by May 30th to take advantage of the Early Adopter discount —save $349!

Luke Kanies

unread,
Sep 3, 2014, 4:18:03 PM9/3/14
to puppe...@googlegroups.com
On Sep 3, 2014, at 11:00 AM, Andy Parker <an...@puppetlabs.com> wrote:

On Wed, Sep 3, 2014 at 4:32 AM, Erik Dalén <erik.gus...@gmail.com> wrote:
It would be nice to remove the document_type from the PSON hashes for Puppet 4. This would be a modification of the API though, so it is a backwards incompatible change. But it is data that AFAIK the agent throws away anyway when it receives it.

The benefit of doing this change is that the API would look the same for all serialisation formats, and a bunch of code for the PSON special handling could be removed. It should be completely backwards compatible for Puppet, but other consumers of the API might be affected.


Here is a example of code that adds this information to the API reply (there's a bunch of places that does this):

And here is the code that throws away that info:

What do you others think about doing that change?


I think that is pretty reasonable. The information can't be very important if puppet doesn't need it in any way. Does anyone know of any consumers of the puppet REST api that depend on this being there?

I don’t think anything uses it.  I put that in there on the assumption that you wouldn’t always be able to do point to point communication, so you’d need some kind of typing.  E.g., if you put that on a message bus, you need some way to know what kind of document it is.  REST is all about talking to specific end points, and we expect the caller to know where to send each kind of document, so it ends up not being used.

This was supposed to turn into an envelope format that allowed us to version the data structures and such, but it doesn’t look like it ever evolved into that.  No idea if this is because we’ve never changed the formats, found another means of versioning them, or what.

Reply all
Reply to author
Forward
0 new messages