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

Reword Headless APIs public documentation based on public feedback

    Details

    • Type: Story
    • Status: Closed
    • Priority: Minor
    • Resolution: Completed
    • Affects Version/s: None
    • Fix Version/s: Master
    • Component/s: Headless Delivery API
    • Labels:
      None
    • Story Points:
      5
    • Sprint:
      HEX #7, HEX #8

      Description

      • Clarify how to launch postman examples and consider to add curl (or other way) of testing the APIs. Because of this:

      - using variable failxs. Postman allows you to set 2 values for a variable - initial and current. I had the initial set only but it turns out it uses the current one

      - To open an installed Postman from link "Run in Postman" on Ubuntu 14.04, I had to add to add postman protocol to mimeapps.list

      And then create a postman.desktop...

      • Simplify documentation to not use HAL or any other Hypermedia format upfront, that way maybe the developer consign the API is scared of learning anything related with Hypermedia formats. Instead, use plain JSON for the first API examples.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              david.gomez David Gómez (Inactive)
              Reporter:
              javier.gamarra Javier Gamarra
              Recent user:
              Kiyoshi Lee
              Participants of an Issue:
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Packages

                  Version Package
                  Master