Grails
  1. Grails
  2. GRAILS-2909

Documentation of converters feature is very sparse

    Details

    • Type: Improvement Improvement
    • Status: Open
    • Priority: Critical Critical
    • Resolution: Unresolved
    • Affects Version/s: 1.0.2
    • Fix Version/s: None
    • Component/s: Converters
    • Labels:
      None

      Description

      The docs for render() method just mention as XML / as JSON in passing, there is no other reference to grails converters I can find.

        Issue Links

          Activity

          Hide
          Brad Whitaker added a comment -

          Siegfried,

          The changes to the docs are great. There are a couple more things that might be useful to add:

          • CODECS section: is the default the regular converter or deep converter? Is there a way to change between regular and deep?
          • Parse section: can the example be extended to show how to take the parsed contents and update and/or create a domain object? (I'm unclear whether or not there is any real support for this. I currently have hand written code to convert parsed XML into domain objects. Even if there is no real support for this then it would still be good to explicitly say so – I think it is a common concern. I've been looking at the code and XStream docs and it seems that XStream supports decoding but not the Grails XML converters. Unless I'm missing something.)

          Thanks,

          Brad

          Show
          Brad Whitaker added a comment - Siegfried, The changes to the docs are great. There are a couple more things that might be useful to add: CODECS section: is the default the regular converter or deep converter? Is there a way to change between regular and deep? Parse section: can the example be extended to show how to take the parsed contents and update and/or create a domain object? (I'm unclear whether or not there is any real support for this. I currently have hand written code to convert parsed XML into domain objects. Even if there is no real support for this then it would still be good to explicitly say so – I think it is a common concern. I've been looking at the code and XStream docs and it seems that XStream supports decoding but not the Grails XML converters. Unless I'm missing something.) Thanks, Brad
          Hide
          Brad Whitaker added a comment -

          My two cents is that a new Converters section is warranted for the following reasons:

          • Converters are already relevant to (and should be cross referenced from):
            • 6.1.7 XML and JSON Responses
            • 6.7.4 Ajax on the Server
            • 6.8 Content Negotiation
            • 13.1 REST - Marshaling
          • Converters have application beyond Ajax and REST. (In my case I'm interested in synchronizing domain objects to/from XML files.) If the documentation remains inside Ajax or REST sections is will most likely be overlooked by users that would like to do conversion that is unrelated to Ajax or REST.
          Show
          Brad Whitaker added a comment - My two cents is that a new Converters section is warranted for the following reasons: Converters are already relevant to (and should be cross referenced from): 6.1.7 XML and JSON Responses 6.7.4 Ajax on the Server 6.8 Content Negotiation 13.1 REST - Marshaling Converters have application beyond Ajax and REST. (In my case I'm interested in synchronizing domain objects to/from XML files.) If the documentation remains inside Ajax or REST sections is will most likely be overlooked by users that would like to do conversion that is unrelated to Ajax or REST.
          Hide
          Graeme Rocher added a comment -

          There is no scope / time to resolve these remaining lower priority issues for 1.2 so moving to 1.3

          for 1.2 final only issues considered blocking will now be fixed

          Show
          Graeme Rocher added a comment - There is no scope / time to resolve these remaining lower priority issues for 1.2 so moving to 1.3 for 1.2 final only issues considered blocking will now be fixed
          Hide
          Graeme Rocher added a comment -

          There is an excellent article on the topic here http://jwicz.wordpress.com/2011/07/11/grails-custom-xml-marshaller/ that should be rolled into the documentation

          Show
          Graeme Rocher added a comment - There is an excellent article on the topic here http://jwicz.wordpress.com/2011/07/11/grails-custom-xml-marshaller/ that should be rolled into the documentation
          Hide
          cdeszaq added a comment -

          It would make sense for this to be fixed for v2.2 with the planed additional REST support for that version of Grails.

          Show
          cdeszaq added a comment - It would make sense for this to be fixed for v2.2 with the planed additional REST support for that version of Grails.

            People

            • Assignee:
              Siegfried Puchbauer
              Reporter:
              Marc Palmer
            • Votes:
              6 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

              • Created:
                Updated:
                Last Reviewed:

                Development