droolsjbpm/guvnor — comment on commit da11f50af7160e7a9c870f5965c08b26c4f3d5c4
File:  line 0
By ge0ffrey:

Op 15-02-12 03:00, Jervis Liu schreef:
> The change on 5.3.x is for BRMS 5.3. Note, JAX-RS based REST interface
> is not "officially" available in Guvnor 5.2/BRMS 5.2, we dont even
> have any document to document this part:
> http://docs.jboss.org/drools/release/5.2.0.Final/drools-guvnor-docs/html/index.html.
> As far as BRMS5.3 is concerned, this release is the first time the
> JAX-RS REST interface is made available for public.
Yes, no discussion there :)
> Its a different story though on master branch. Geoffrey, can I ping
> on IRC to discuss? I gut feeling though is that we really need to
> break the backwards compatibility in order to have a better and
> cleaner model.
I am not necessarily against backwards compatibility breaking, but we
need to be very aware of it and inform our users adequately.
Simple put, add BEFORE and AFTER documentation in docbook (for an
example see [1]),
either in the guvnor-docs section "upgrading from ..." with mention
about it in the introduction-docs.
It could show te XML output before, and the XML output after.

[1]
https://github.com/droolsjbpm/drools-planner/blob/master/drools-planner-distribution/src/main/assembly/filtered-resources/UpgradeFromPreviousVersionRecipe.txt#L1395

With kind regards,
Geoffrey De Smet
> Thanks,
> Jervis
>
> On Wed, Feb 15, 2012 at 12:16 AM, Geoffrey De Smet
>
> wrote:
>> Won't these changes break backwards compatibility of the REST API? Note that customers are using our REST API.
>>
>> I am forward porting other REST changes and adjusting them to this new layout. If this commit gets reverted, those forward ported changes need to be adjusted correctly: more specifically, in that case binaryContentAttachmentFileName should come on AssetMetadata, not Asset.
>>
>> Original changes on 5.3.x:
>> https://github.com/droolsjbpm/guvnor/compare/07bf9bf...315199c
>> Forward ported changes on master:
>> TODO
>>
>> ---
>> Reply to this email directly or view it on GitHub:
>> https://github.com/droolsjbpm/guvnor/commit/da11f50af7160e7a9c870f5965c08b26c4f3d5c4#commitcomment-965161
> ---
> Reply to this email directly or view it on GitHub:
> https://github.com/droolsjbpm/guvnor/commit/da11f50af7160e7a9c870f5965c08b26c4f3d5c4#commitcomment-967544