Document API client classes for spam report

src/main/java/org/eclipsefoundation/reports/api/AccountsAPI.java

@@ -20,15 +20,29 @@ import org.eclipsefoundation.reports.api.models.EclipseForumResponse;
 import org.eclipsefoundation.reports.api.models.EclipseMailingListsResponse;
 
 /**
- * 
+ * Connects to the Eclipse Foundation metadata links for users to lookup whether users have interacted with common
+ * services, such as the forum and mailing list subscriptions.
  */
 @RegisterRestClient(baseUri = "https://api.eclipse.org/account/profile")
 public interface AccountsAPI {
 
+    /**
+     * Lookup forum post information for the given user.
+     * 
+     * @param user username of individual to lookup
+     * @return list of forum posts for the passed user if they exist
+     */
     @GET
     @Path("{user}/forum")
     EclipseForumResponse getForumPostsForUser(@PathParam("user") String user);
 
+
+    /**
+     * Lookup mailing list subscription information for the given user.
+     * 
+     * @param user username of individual to lookup
+     * @return list of mailing list subscriptions for the passed user if they exist
+     */
     @GET
     @Path("{user}/mailing-list")
     EclipseMailingListsResponse getMailingListForUser(@PathParam("user") String user);

src/main/java/org/eclipsefoundation/reports/api/MediaWikiAPI.java

@@ -20,15 +20,25 @@ import org.eclipse.microprofile.rest.client.inject.RegisterRestClient;
 import org.eclipsefoundation.reports.api.models.MediaWikiQueryResponse;
 
 /**
- * 
+ * Client for interacting with the Eclipse mediawiki to look up whether users have mad contributions in the wiki as an
+ * active user metric.
  */
 @RegisterRestClient(baseUri = "https://wiki.eclipse.org")
 public interface MediaWikiAPI {
 
+    /**
+     * Query the mediawiki instance to look up user contributions as defined in the param object.
+     * 
+     * @param param wrapped parameters used to query user contributions
+     * @return the response from mediawiki for the query.
+     */
     @GET
     @Path("api.php")
     MediaWikiQueryResponse query(@BeanParam MWQuery param);
 
+    /**
+     * Parameter wrapper for mediawiki queries, allowing us to look up specific user stats for requested actions.
+     */
     public class MWQuery {
         @QueryParam("ucuser")
         public final String user;