November 2014
Twan Goosen

Component Registry Front-end Specification

Note: the term 'component' refers to both components and profiles unless mentioned otherwise.

Global requirements

• Use authentication state is retrieved from the backend
  • This includes admin status of the logged in user

Browser

• Listing
  • Fields: Name, Group, Domain, Creator, Description, Registration Date, Comments
  • Sortable by any field
  • Search/filtering
    • Also by component ID
• Details
  • Hierarchical view
  • Verbatim XML
    • Truncated if too long

Spaces

• Public space
  • {REST_BASE}/registry/components
  • {REST_BASE}/registry/profiles
• Private workspace
  • {REST_BASE}/registry/components?registryspace=private
  • {REST_BASE}/registry/profiles?registryspace=private
• Group workspaces
  • {REST_BASE}/registry/components?registryspace=group&group={GROUP_ID}
  • {REST_BASE}/registry/profiles?registryspace=group&group={GROUP_ID}

• CMDI 1.2: Review space

Comments

• Logged in users can see all existing comments on any component they can see.
• Logged in users can create comments on any component they can see.
• Users can remove the comments that they created themselves
• Admins can remove any comment

RSS

Links to the following RSS feeds (generated by the back-end) are present:

• Any components space
• Comments on any specific component

Editor

Importer