docs: generate javadocs with docgenerator

Author: tharropoulos

src/main/java/org/typesense/api/Alias.java

@@ -13,10 +13,29 @@ public Alias(ApiCall apiCall, String name) {
         this.name = name;
     }
 
+    /**
+     * Retrieve an alias.
+     *
+     * <p>
+     * Find out which collection an alias points to by fetching it
+     *
+     * <p>
+     * HTTP: GET /aliases/{aliasName}
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/collections.html">Typesense docs</a>
+     */
     public CollectionAlias retrieve() throws Exception {
         return this.apiCall.get(this.getEndpoint(), null, CollectionAlias.class);
     }
 
+    /**
+     * Delete an alias.
+     *
+     * <p>
+     * HTTP: DELETE /aliases/{aliasName}
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/collections.html">Typesense docs</a>
+     */
     public CollectionAlias delete() throws Exception {
         return this.apiCall.delete(this.getEndpoint(), null, CollectionAlias.class);
     }

src/main/java/org/typesense/api/Aliases.java

@@ -14,11 +14,33 @@ public Aliases(ApiCall apiCall) {
         this.apiCall = apiCall;
     }
 
+    /**
+     * Create or update a collection alias.
+     *
+     * <p>
+     * Create or update a collection alias. An alias is a virtual collection name that points to a real collection. If you're familiar with symbolic links on Linux, it's very similar to that. Aliases are useful when you want to reindex your data in the background on a new collection and switch your application to it without any changes to your code.
+     *
+     * <p>
+     * HTTP: PUT /aliases/{aliasName}
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/collections.html">Typesense docs</a>
+     */
     public CollectionAlias upsert(String name, CollectionAliasSchema collectionAliasSchema) throws Exception {
         return this.apiCall.put(RESOURCE_PATH + "/" + URLEncoding.encodeURIComponent(name), collectionAliasSchema, null,
                 CollectionAlias.class);
     }
 
+    /**
+     * List all aliases.
+     *
+     * <p>
+     * List all aliases and the corresponding collections that they map to.
+     *
+     * <p>
+     * HTTP: GET /aliases
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/collections.html">Typesense docs</a>
+     */
     public CollectionAliasesResponse retrieve() throws Exception {
         return this.apiCall.get(RESOURCE_PATH, null, CollectionAliasesResponse.class);
     }

src/main/java/org/typesense/api/AnalyticsEvents.java

@@ -13,10 +13,32 @@ public AnalyticsEvents(ApiCall apiCall) {
         this.apiCall = apiCall;
     }
 
+    /**
+     * Create an analytics event.
+     *
+     * <p>
+     * Submit a single analytics event. The event must correspond to an existing analytics rule by name.
+     *
+     * <p>
+     * HTTP: POST /analytics/events
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/analytics-query-suggestions.html">Typesense docs</a>
+     */
     public AnalyticsEventCreateResponse create(AnalyticsEvent event) throws Exception {
         return this.apiCall.post(RESOURCE_PATH, event, null, AnalyticsEventCreateResponse.class);
     }
 
+    /**
+     * Retrieve analytics events.
+     *
+     * <p>
+     * Retrieve the most recent events for a user and rule.
+     *
+     * <p>
+     * HTTP: GET /analytics/events
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/analytics-query-suggestions.html">Typesense docs</a>
+     */
     public AnalyticsEventsResponse retrieve(Map<String, Object> params) throws Exception {
         return this.apiCall.get(RESOURCE_PATH, params, AnalyticsEventsResponse.class);
     }

src/main/java/org/typesense/api/AnalyticsRule.java

@@ -20,18 +20,51 @@ public AnalyticsRule(String ruleId, ApiCall apiCall, AnalyticsRuleSerializer ser
         this.serializer = serializer;
     }
 
+    /**
+     * Retrieves an analytics rule.
+     *
+     * <p>
+     * Retrieve the details of an analytics rule, given it's name
+     *
+     * <p>
+     * HTTP: GET /analytics/rules/{ruleName}
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/analytics-query-suggestions.html">Typesense docs</a>
+     */
     public org.typesense.model.AnalyticsRule retrieve() throws Exception {
         String response = this.apiCall.get(this.getEndpoint(), null, String.class);
         return serializer.parseFromJson(response);
     }
 
+    /**
+     * Delete an analytics rule.
+     *
+     * <p>
+     * Permanently deletes an analytics rule, given it's name
+     *
+     * <p>
+     * HTTP: DELETE /analytics/rules/{ruleName}
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/analytics-query-suggestions.html">Typesense docs</a>
+     */
     public org.typesense.model.AnalyticsRule delete() throws Exception {
         String response = this.apiCall.delete(this.getEndpoint(), null, String.class);
         org.typesense.model.AnalyticsRule result = new org.typesense.model.AnalyticsRule();
         result.name(this.ruleId);
         return result;
     }
 
+    /**
+     * Upserts an analytics rule.
+     *
+     * <p>
+     * Upserts an analytics rule with the given name.
+     *
+     * <p>
+     * HTTP: PUT /analytics/rules/{ruleName}
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/analytics-query-suggestions.html">Typesense docs</a>
+     */
     public org.typesense.model.AnalyticsRule update(AnalyticsRuleUpdate rule) throws Exception {
         return this.apiCall.put(this.getEndpoint(), rule, null, org.typesense.model.AnalyticsRule.class);
     }

src/main/java/org/typesense/api/AnalyticsRules.java

@@ -20,11 +20,33 @@ public AnalyticsRules(ApiCall apiCall, AnalyticsRuleSerializer serializer) {
         this.serializer = serializer;
     }
 
+    /**
+     * Create analytics rule(s).
+     *
+     * <p>
+     * Create one or more analytics rules. You can send a single rule object or an array of rule objects.
+     *
+     * <p>
+     * HTTP: POST /analytics/rules
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/analytics-query-suggestions.html">Typesense docs</a>
+     */
     public AnalyticsRulesResponse create(List<AnalyticsRuleCreate> rules) throws Exception {
         String response = this.apiCall.post(RESOURCE_PATH, rules, null, String.class);
         return parseCreateResponse(response);
     }
 
+    /**
+     * Retrieve analytics rules.
+     *
+     * <p>
+     * Retrieve all analytics rules. Use the optional rule_tag filter to narrow down results.
+     *
+     * <p>
+     * HTTP: GET /analytics/rules
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/analytics-query-suggestions.html">Typesense docs</a>
+     */
     public List<AnalyticsRule> retrieve() throws Exception {
         String response = this.apiCall.get(RESOURCE_PATH, null, String.class);
         return parseRetrieveResponse(response);

src/main/java/org/typesense/api/Collection.java

@@ -34,14 +34,47 @@ public class Collection {
         this.individualSynonyms = new HashMap<>();
     }
 
+    /**
+     * Retrieve a single collection.
+     *
+     * <p>
+     * Retrieve the details of a collection, given its name.
+     *
+     * <p>
+     * HTTP: GET /collections/{collectionName}
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/collections.html">Typesense docs</a>
+     */
     public CollectionResponse retrieve() throws Exception {
         return this.apiCall.get(endpoint, null, CollectionResponse.class);
     }
 
+    /**
+     * Update a collection.
+     *
+     * <p>
+     * Update a collection's schema to modify the fields and their types.
+     *
+     * <p>
+     * HTTP: PATCH /collections/{collectionName}
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/collections.html">Typesense docs</a>
+     */
     public CollectionUpdateSchema update(CollectionUpdateSchema c) throws Exception {
         return this.apiCall.patch(endpoint, c, null, CollectionUpdateSchema.class);
     }
 
+    /**
+     * Delete a collection.
+     *
+     * <p>
+     * Permanently drops a collection. This action cannot be undone. For large collections, this might have an impact on read latencies.
+     *
+     * <p>
+     * HTTP: DELETE /collections/{collectionName}
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/collections.html">Typesense docs</a>
+     */
     public CollectionResponse delete() throws Exception {
         return this.apiCall.delete(endpoint, null, CollectionResponse.class);
     }

src/main/java/org/typesense/api/Collections.java

@@ -12,14 +12,47 @@ public Collections(ApiCall apiCall){
         this.apiCall = apiCall;
     }
 
+    /**
+     * Create a new collection.
+     *
+     * <p>
+     * When a collection is created, we give it a name and describe the fields that will be indexed from the documents added to the collection.
+     *
+     * <p>
+     * HTTP: POST /collections
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/collections.html">Typesense docs</a>
+     */
     public CollectionResponse create(CollectionSchema c) throws Exception {
         return this.apiCall.post(RESOURCE_PATH, c, null, CollectionResponse.class);
     }
 
+    /**
+     * Create a new collection.
+     *
+     * <p>
+     * When a collection is created, we give it a name and describe the fields that will be indexed from the documents added to the collection.
+     *
+     * <p>
+     * HTTP: POST /collections
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/collections.html">Typesense docs</a>
+     */
     public CollectionResponse create(String schemaJson) throws Exception {
         return this.apiCall.post(RESOURCE_PATH, schemaJson, null, CollectionResponse.class);
     }
 
+    /**
+     * List all collections.
+     *
+     * <p>
+     * Returns a summary of all your collections. The collections are returned sorted by creation date, with the most recent collections appearing first.
+     *
+     * <p>
+     * HTTP: GET /collections
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/collections.html">Typesense docs</a>
+     */
     public CollectionResponse[] retrieve() throws Exception {
         return this.apiCall.get(RESOURCE_PATH, null, CollectionResponse[].class);
     }

src/main/java/org/typesense/api/CurationSet.java

@@ -15,14 +15,47 @@ public CurationSet(String curationSetName, ApiCall apiCall) {
         this.apiCall = apiCall;
     }
 
+    /**
+     * Retrieve a curation set.
+     *
+     * <p>
+     * Retrieve a specific curation set by its name
+     *
+     * <p>
+     * HTTP: GET /curation_sets/{curationSetName}
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/curation.html">Typesense docs</a>
+     */
     public CurationSetCreateSchema retrieve() throws Exception {
         return this.apiCall.get(this.getEndpoint(), null, CurationSetCreateSchema.class);
     }
 
+    /**
+     * Create or update a curation set.
+     *
+     * <p>
+     * Create or update a curation set with the given name
+     *
+     * <p>
+     * HTTP: PUT /curation_sets/{curationSetName}
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/curation.html">Typesense docs</a>
+     */
     public CurationSetSchema upsert(CurationSetCreateSchema curationSetCreateSchema) throws Exception {
         return this.apiCall.put(this.getEndpoint(), curationSetCreateSchema, null, CurationSetSchema.class);
     }
 
+    /**
+     * Delete a curation set.
+     *
+     * <p>
+     * Delete a specific curation set by its name
+     *
+     * <p>
+     * HTTP: DELETE /curation_sets/{curationSetName}
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/curation.html">Typesense docs</a>
+     */
     public CurationSetDeleteSchema delete() throws Exception {
         return this.apiCall.delete(this.getEndpoint(), null, CurationSetDeleteSchema.class);
     }

src/main/java/org/typesense/api/CurationSets.java

@@ -12,10 +12,32 @@ public CurationSets(ApiCall apiCall) {
         this.apiCall = apiCall;
     }
 
+    /**
+     * Create or update a curation set.
+     *
+     * <p>
+     * Create or update a curation set with the given name
+     *
+     * <p>
+     * HTTP: PUT /curation_sets/{curationSetName}
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/curation.html">Typesense docs</a>
+     */
     public CurationSetSchema upsert(String curationSetName, CurationSetCreateSchema curationSetCreateSchema) throws Exception {
         return this.apiCall.put(getEndpoint(curationSetName), curationSetCreateSchema, null, CurationSetSchema.class);
     }
 
+    /**
+     * Retrieve a curation set.
+     *
+     * <p>
+     * Retrieve a specific curation set by its name
+     *
+     * <p>
+     * HTTP: GET /curation_sets/{curationSetName}
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/curation.html">Typesense docs</a>
+     */
     public CurationSetSchema[] retrieve() throws Exception {
         return this.apiCall.get(this.getEndpoint(null), null, CurationSetSchema[].class);
     }

src/main/java/org/typesense/api/Debug.java

@@ -11,6 +11,14 @@ public Debug(ApiCall apiCall) {
         this.apiCall = apiCall;
     }
 
+    /**
+     * Print debugging information.
+     *
+     * <p>
+     * HTTP: GET /debug
+     *
+     * @see <a href="https://typesense.org/docs/latest/api/cluster-operations.html#debug">Typesense docs</a>
+     */
     public Map<String, Object> retrieve() throws Exception {
         return this.apiCall.get(RESOURCEPATH, null, Map.class);
     }