Uploaded image for project: 'PUBLIC - Liferay Portal Community Edition'
  1. PUBLIC - Liferay Portal Community Edition
  2. LPS-84736

ContentStructure API renaming properties

    Details

      Description

      API Capabilities
      The consumer of this API will be able to:

      • Retrieve the needed information of a contentStructure in order to be able to understand the information in it.
        • Rename  "dataTypes" property values:
          • “"dataType": "journal-article” to “structuredContent”
          • "dataType": "link-to-page" to "url" (it looks like we are not showing it)
          • "dataType": "document-library", -> “document”
          • -"dataType :  "radio" -> "string"
        • Rename "additionalType" property to "inputControl" and have the following values:
          • "inputControl": "checkbox"
          • "inputControl": "radio"
          • "inputControl": "select"
          • "inputControl": "text"
          • "inputControl": "textArea"

      Security requirements

      The list should contain only the elements the user has permission to view. If a content structure is requested and the current user doesn't have permission to view it, a 404 error should be returned.

      General requirements
      The API should support at least Plain JSON, JSON-LD and HAL as output formats.

      The consumer developer should be able to control which linked resources are embedded so that they can be retrieved along with a content structure in a single request.

      The consumer developer can specify which fields are desired, to reduce the data transfer when the API is used from a consumer sensitive to it.

       

      Acceptance Criteria

       

      Given a structure like structure.json

      when I retrieve through the API that content

      Then the response is a Json like structure.json

       

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                pablo.agulla Pablo Agulla
                Reporter:
                pablo.agulla Pablo Agulla
                Recent user:
                Brian Chan
                Participants of an Issue:
              • Votes:
                0 Vote for this issue
                Watchers:
                0 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Packages

                  Version Package
                  7.1.X
                  Headless-A2
                  Master