[zanata/zanata-platform] d91ea8: Improve REST API docs (#415)

[GitHub]

  Branch: refs/heads/master
  Home:   https://github.com/zanata/zanata-platform
  Commit: d91ea8835a23aea385e5bbad1f894c2912c87161
      https://github.com/zanata/zanata-platform/commit/d91ea8835a23aea385e5bbad1f894c2912c87161
  Author: Carlos Munoz <chavo16 at hotmail.com>
  Date:   2017-07-17 (Mon, 17 Jul 2017)

  Changed paths:
    M api/zanata-common-api/src/main/java/org/zanata/common/EntityStatus.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/CopyTransStatus.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/GlossaryEntry.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/GlossaryInfo.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/GlossaryLocaleInfo.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/GlossaryResults.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/GlossaryTerm.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/Link.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/Links.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/LocaleDetails.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/Project.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/ProjectIteration.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/QualifiedName.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/ResultList.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/VersionInfo.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/resource/Resource.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/resource/TranslationsResource.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/stats/ContainerTranslationStatistics.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/stats/TranslationStatistics.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/stats/contribution/BaseContributionStatistic.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/stats/contribution/ContributionStatistics.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/dto/stats/contribution/LocaleStatistics.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/service/CopyTransResource.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/service/GlossaryResource.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/service/ProjectsResource.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/service/StatisticsResource.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/service/TranslatedDocResource.java
    M api/zanata-common-api/src/main/java/org/zanata/rest/service/VersionResource.java
    R server/zanata-war/src/main/java/org/zanata/rest/service/package-info.java

  Log Message:
  -----------
  Improve REST API docs (#415)

* code review changes

* improve REST documentation for the copy trans resource

* improve REST API docs for project list resource

* improve REST API docs for statistics endpoint

* improve REST API documentation for system version endpoint

* add REST api docs for Glossary endpoint

* improve REST API documentation for Translations endpoint

* code review corrections