Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NodeData is not treated as a node in the tree. Instead a returned node in the tree contains NodeDatas that should be rendered as subnodes in the displayed tree. The returned node has column values for each NodeData.

to be decided: how is a content menu item mapped to a command? the client should have minimal knowledge of what commands exist

  • get child nodes
    • method: GET
    • path: .magnolia/rest/tree/<treeName>/<path>
    • arguments: treeName and path in uri
    • returns: TreeNodeList
  • get tree configuration
    • method: POST
    • path: .magnolia/rest/tree/<treeName>/config
    • arguments: treeName in uri
    • returns: JsonTreeConfiguration
  • execute command
    • method: POST
    • path: .magnolia/rest/tree/<treeName>/<path>/command
    • arguments: treeName and path in uri, parameter command is the name of the command, rest of parameter are used by the actual command
    • returns: depends on the command, must be able to also output a message (AlertUtil-style)

...

Dialogs (.magnolia/rest/dialogs/)

status: has tabs, validation, supports only edit and date controls

  • load dialog
    • method GET
    • path .magnolia/rest/dialogs/<dialogName>
    • arguments
      • mgnlRepository
      • mgnlPath
      • mgnlNodeCollectionName
      • mgnlNode
    • returns
      • Dialog populated from repository
    • example /.magnolia/rest/dialogs/howTo?mgnlRepository=website&mgnlPath=/howTo-jsp/main/0
  • create node with dialog
    • method POST
    • path .magnolia/rest/dialogs/<dialogName>/create
    • arguments
      • mgnlRepository
      • mgnlPath
      • mgnlNodeCollectionName
      • mgnlNode
    • returns
      • ValidationResult
    • example /.magnolia/rest/dialogs/howTo/create?mgnlRepository=website&mgnlPath=/howTo-jsp&mgnlNodeCollectionName=main&title=ASDFGH12345
  • update node with dialog
    • method POST
    • path .magnolia/rest/dialogs/<dialogName>/update
    • arguments
      • mgnlRepository
      • mgnlPath
      • mgnlNodeCollectionName
      • mgnlNode
    • returns
      • ValidationResult
    • example /.magnolia/rest/dialogs/howTo/update?mgnlRepository=website&mgnlPath=/howTo-jsp/main/0&title=ASDFGH12345

...