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

Add OpenAPI rules to Source Formatter to help write better OpenAPI documentation

    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

      Updating the Headless Delivery OpenAPI documentation some common problems have arisen that good be would candidates as rules for Source Formatter.

      The proposed rules are:

      • Enforce description field style rules: The description should start with an uppercase letter, end with a '.' character and be written without surrounded double quotes
      • All components and properties should have a description field. This could be implemented as a warning
      • New components and properties should have a description field with a previous comment line with the @review text to indicate to the documentation team that this description should be reviewed:
      # @review
      description:
          New description
      • Transform some of the REST Builder transformations as Source Formatter rules of the OpenAPI file

        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