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

Review OpenAPI description fields with documentation team

    Details

    • Type: Task
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Headless Delivery API
    • Labels:
      None

      Description

      Improve the description field comments to be more explicit. Involve documentation team in it:

      • Try to avoid obvious descriptions like: "A list of...". Ideally this should bridge the needs of documentation of 2 users: the one that already knows liferay (custom fields that map to expando fields) and the ones that do not know liferay (custom fields allow you to define new fields to a Liferay entity).
      • Bridge related contents to related assets.
      • In the actions block descriptions, explain what "actions" are and link to the actions documentation page

       

      Original comments: https://github.com/liferay-headless/liferay-portal/pull/686

        Attachments

          Activity

            People

            Assignee:
            support-lep@liferay.com SE Support
            Reporter:
            javier.dearcos Javier de Arcos Velilla
            Recent user:
            Javier de Arcos Velilla
            Participants of an Issue:
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Dates

              Created:
              Updated:

                Packages

                Version Package