Details

    • Type: Enhancement
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Migrated to another ITS
    • Affects Version/s: 5.2.0.GA
    • Fix Version/s: 5.2.1.GA
    • Component/s: docs-Admin_Guide
    • Labels:
      None
    • Affects:
      Documentation (Ref Guide, User Guide, etc.)
    • NEEDINFO:
      Nobody

      Description

      Hello,

      I have been working with our EPP REST API it's a really great API. Unfortunately the documentation[1] has some obscure points. Here are some suggestions for improving the REST API documentation:

      • The warn "All URL's below are relative to the REST management entry point of the portal container." is useful, but it doesn't mention what is the entry point. It would be great to know the entry point even if you use a clean installation as example;
      • You should explore more the JSON part of the API. The JSON implements HATEOAS and after I found the first page I could navigate by all the API only using the HATEOAS feature;
      • I would like suggest to give more examples using a clean EPP installation. The most good part of an API is to test it ;
      • I wish we could have something like .org documentation[2].

      That's it, these are my suggestions.

      [1] http://red.ht/uLBwDX
      [2] https://docs.jboss.org/author/display/GTNPORTAL/GateIn+Management

      Thanks.

        Gliffy Diagrams

          Attachments

            Activity

              People

              • Assignee:
                nscavell Nick Scavelli
                Reporter:
                williamAntonio William Siqueira
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: