Details

    • Type: Epic
    • Status: Closed
    • Priority: Minor
    • Resolution: Completed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Headless CMS
    • Labels:
      None

      Description

      The APIs should provide a profile where it documents the types and links used in the APIs so a consumer and/or developer can understand and create an application that consumes the Hypermedia APIs

       

      -Rename and restructure resources

      -Specify API profile

      -Populate API profile

      • Publish web version of the profile

      Goal

      Provide the proper documentation of the API to a developer or consumer

      Motivation

      Developers and consumers will make the most of the hypermedia APIs when the documentation of them is clear and includes all the necessary information to understand what the API is capable of, which data is expecting, which data will be returned, errors returned, etc.

      Usecase

       

      Given a customer providing a hypermedia API built with APIO from a Liferay instance

      When a consumer access the API profile url

      Then the profile includes information about:

      • types
      • properties
        • field type
        • description
        • validation
      • operations available
      • forms expected
        • properties needed
        • required properties
        • field types

       

      Given a customer providing a hypermedia API built with APIO from a Liferay instance

      When a developer access the webpage generated with the documentation

      Then they can check information about:

      • types
      • properties
        • field type
        • description
        • validation
      • operations available
      • forms expected
        • properties needed
        • required properties
        • field types

        Attachments

          Activity

            People

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

              Dates

              • Created:
                Updated:
                Resolved:

                Packages

                Version Package