Wookie
  1. Wookie
  2. WOOKIE-327

Make widget metadata returned by the REST API more consistent with W3C Widget Config.xml, remove confusing IDs

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 0.10.0
    • Fix Version/s: 0.10.0
    • Component/s: None
    • Labels:
      None

      Description

      The metadata returned by Wookie for GET /widgets and GET /widgets/

      {id_or_uri}

      is slightly confusing in that it doesn't quite follow the W3C widget spec (e.g. it has <title> instead of <name>) and it contains two different attributes for identifiers:

      id == the wookie internal JPA identifier
      identifier == the W3C Widget id

      I propose making the following changes:

      1. Change "title" to "name"
      2. Remove "identifier"
      3. Change the content of "id" to the W3C Widget URI id (as provided in config.xml
      4. Change <icon>

      {URL}</icon> to <icon src="{URL}

      "/>

      This has implications for connectors, which will need to be updated to the same version as the Wookie server.

        Activity

        Hide
        Paul Sharples added a comment -

        Verified, all updates/changes appear as stated. Notes also added to the UPGRADING file regarding the changes in the metadata format.

        Show
        Paul Sharples added a comment - Verified, all updates/changes appear as stated. Notes also added to the UPGRADING file regarding the changes in the metadata format.
        Hide
        Scott Wilson added a comment -

        I've attached the patch for this to make it easier to sync this work with the changes needed for the connector framework (see WOOKIE-326)

        Show
        Scott Wilson added a comment - I've attached the patch for this to make it easier to sync this work with the changes needed for the connector framework (see WOOKIE-326 )

          People

          • Assignee:
            Scott Wilson
            Reporter:
            Scott Wilson
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development