You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@camel.apache.org by "Jeremy Ross (Jira)" <ji...@apache.org> on 2021/03/23 01:26:00 UTC

[jira] [Updated] (CAMEL-16388) camel-salesforce: drop support for XML as a serialization format

     [ https://issues.apache.org/jira/browse/CAMEL-16388?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jeremy Ross updated CAMEL-16388:
--------------------------------
    Description: 
Putting this out here for a discussion. 

The salesforce REST APIs support XML and JSON. However, it's clear from the official documentation and examples that JSON is the first-class citizen. All the examples are in JSON and there's only this one, sad reference to XML serialization:  

{quote}XML serialization is similar to SOAP API. XML requests are supported in UTF-8 and UTF-16, and XML responses are provided in UTF-8.{quote}

This leaves us Camel maintainers with the not-fun activity of guessing how salesforce expects its myriad types to be serialized to XML. 

I suspect that Camel users don't really care that much which serialization format is used. Both have equal parity with salesforce, and as a Camel user I just care that Camel serializes and deserializes my DTOs correctly. Wire format is an abstraction that shouldn't matter. This is the crux of my argument.

Camel's support for both formats is a maintenance burden, and a barrier to developing future features and support for newer APIs. Serialization format isn't a concern to users, and supporting both formats is of no real value. Therefore, I'd like to consider dropping XML support, leaving JSON as the supported format.

Note that this does not affect the `rawPayload` option. Users would still be welcome to provide their own raw payloads in either format. 

Paging for comment: [~zregvart] [~davsclaus] [~jbonofre]

  was:
Putting this out here for a discussion. 

The salesforce REST APIs support XML and JSON. However, it's clear from the official documentation and examples that JSON is the first-class citizen. All the examples are in JSON and there's only this one, sad reference to XML serialization:  

{quote}XML serialization is similar to SOAP API. XML requests are supported in UTF-8 and UTF-16, and XML responses are provided in UTF-8.{quote}

This leaves us Camel maintainers with the not-fun activity of guessing how salesforce expects its myriad types to be serialized to XML. 

I suspect that Camel users don't really care that much which serialization format is used. Both have equal parity with salesforce, and as a Camel user I just care that Camel serializes and deserializes my DTOs correctly. Wire format is an abstraction that shouldn't matter. This is the crux of my argument.

Camel's support for both formats is a maintenance burden, and a barrier to developing future features and support for newer APIs. Serialization format isn't a concern to users, and the burden of supporting both formats is of no real value. Therefore, I'd like to consider dropping XML support, leaving JSON as the supported format.

Note that this does not affect the `rawPayload` option. Users would still be welcome to provide their own raw payloads in either format. 

Paging for comment: [~zregvart] [~davsclaus] [~jbonofre]


> camel-salesforce: drop support for XML as a serialization format
> ----------------------------------------------------------------
>
>                 Key: CAMEL-16388
>                 URL: https://issues.apache.org/jira/browse/CAMEL-16388
>             Project: Camel
>          Issue Type: Wish
>          Components: camel-salesforce
>    Affects Versions: 3.8.0
>            Reporter: Jeremy Ross
>            Priority: Major
>             Fix For: 3.10.0
>
>
> Putting this out here for a discussion. 
> The salesforce REST APIs support XML and JSON. However, it's clear from the official documentation and examples that JSON is the first-class citizen. All the examples are in JSON and there's only this one, sad reference to XML serialization:  
> {quote}XML serialization is similar to SOAP API. XML requests are supported in UTF-8 and UTF-16, and XML responses are provided in UTF-8.{quote}
> This leaves us Camel maintainers with the not-fun activity of guessing how salesforce expects its myriad types to be serialized to XML. 
> I suspect that Camel users don't really care that much which serialization format is used. Both have equal parity with salesforce, and as a Camel user I just care that Camel serializes and deserializes my DTOs correctly. Wire format is an abstraction that shouldn't matter. This is the crux of my argument.
> Camel's support for both formats is a maintenance burden, and a barrier to developing future features and support for newer APIs. Serialization format isn't a concern to users, and supporting both formats is of no real value. Therefore, I'd like to consider dropping XML support, leaving JSON as the supported format.
> Note that this does not affect the `rawPayload` option. Users would still be welcome to provide their own raw payloads in either format. 
> Paging for comment: [~zregvart] [~davsclaus] [~jbonofre]



--
This message was sent by Atlassian Jira
(v8.3.4#803005)