diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index cb0b64f4..6c7d2cd9 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -18,6 +18,9 @@ jobs:
java-version: 1.8
- name: Build with Maven
run: mvn -B compile --file pom.xml
+ # generate the javadocs into the target/site/apidocs folder (default)
+ - name: Generate javadocs with Maven
+ run: mvn javadoc:javadoc
unit-tests:
runs-on: ubuntu-latest
diff --git a/README.md b/README.md
index 76cb828c..05cf74f3 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@ The official Java SDK for the Textkernel Tx v10 API for resume/CV and job parsin
### Gradle Users
Add this dependency to your project's build file:
```
-implementation "com.textkernel:tx-java:3.0.0"
+implementation "com.textkernel:tx-java:3.0.1"
```
### Maven Users
@@ -22,13 +22,13 @@ Add this dependency to your project's POM:
com.textkernel
tx-java
- 3.0.0
+ 3.0.1
```
### Others
You'll need to manually install the following JARs:
-- The Textkernel Tx JAR from https://repo1.maven.org/maven2/com/textkernel/tx-java/3.0.0/tx-java-3.0.0.jar
+- The Textkernel Tx JAR from https://repo1.maven.org/maven2/com/textkernel/tx-java/3.0.1/tx-java-3.0.1.jar
- [Google Gson][gson_url] from https://repo1.maven.org/maven2/com/google/code/gson/gson/2.9.0/gson-2.9.0.jar
- [Square OkHttp][okhttp_url] from https://repo1.maven.org/maven2/com/squareup/okhttp3/okhttp/4.12.0/okhttp-4.12.0.jar
diff --git a/pom.xml b/pom.xml
index 084791f3..284e5cd5 100644
--- a/pom.xml
+++ b/pom.xml
@@ -4,7 +4,7 @@
com.textkernel
tx-java
- 3.0.0
+ 3.0.1
jar
Textkernel Tx Java SDK
diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/Options.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/Options.java
index a0c6b992..c1f70694 100644
--- a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/Options.java
+++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/Options.java
@@ -5,6 +5,7 @@
package com.textkernel.tx.models.api.matchV2.querying;
+import com.textkernel.tx.models.api.matchV2.querying.results.SearchResult;
import java.util.List;
/** Options for a Search or Match request */
diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/SearchQuery.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/SearchQuery.java
index d3ec0b5e..c2fe335b 100644
--- a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/SearchQuery.java
+++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/SearchQuery.java
@@ -8,6 +8,7 @@
import java.util.List;
import com.textkernel.tx.models.api.matchV2.querying.results.QueryPart;
+import com.textkernel.tx.models.api.matchV2.querying.results.SearchResult;
/** A search query */
public class SearchQuery {
diff --git a/src/main/java/com/textkernel/tx/services/AccountService.java b/src/main/java/com/textkernel/tx/services/AccountService.java
index d13e0856..93d132d8 100644
--- a/src/main/java/com/textkernel/tx/services/AccountService.java
+++ b/src/main/java/com/textkernel/tx/services/AccountService.java
@@ -17,7 +17,11 @@
/** See {@link TxClient#account()} */
public class AccountService extends ServiceBase {
- /** See {@link TxClient#account()} */
+ /**
+ * Do not use this. See {@link TxClient#account()}
+ * @param httpClient The http client for API calls
+ * @param settings environment settings
+ */
public AccountService(OkHttpClient httpClient, EnvironmentSettings settings) {
super(httpClient, settings);
}
diff --git a/src/main/java/com/textkernel/tx/services/FormatterService.java b/src/main/java/com/textkernel/tx/services/FormatterService.java
index d334da8b..4cc8fa07 100644
--- a/src/main/java/com/textkernel/tx/services/FormatterService.java
+++ b/src/main/java/com/textkernel/tx/services/FormatterService.java
@@ -19,7 +19,11 @@
/** See {@link TxClient#formatter()} */
public class FormatterService extends ServiceBase {
- /** See {@link TxClient#formatter()} */
+ /**
+ * Do not use this. See {@link TxClient#formatter()}
+ * @param httpClient The http client for API calls
+ * @param settings environment settings
+ */
public FormatterService(OkHttpClient httpClient, EnvironmentSettings settings) {
super(httpClient, settings);
}
diff --git a/src/main/java/com/textkernel/tx/services/GeocoderService.java b/src/main/java/com/textkernel/tx/services/GeocoderService.java
index 297832ca..503497aa 100644
--- a/src/main/java/com/textkernel/tx/services/GeocoderService.java
+++ b/src/main/java/com/textkernel/tx/services/GeocoderService.java
@@ -35,7 +35,11 @@
/** See {@link TxClient#geocoder()} */
public class GeocoderService extends ServiceBase {
- /** See {@link TxClient#geocoder()} */
+ /**
+ * Do not use this. See {@link TxClient#geocoder()}
+ * @param httpClient The http client for API calls
+ * @param settings environment settings
+ */
public GeocoderService(OkHttpClient httpClient, EnvironmentSettings settings) {
super(httpClient, settings);
}
diff --git a/src/main/java/com/textkernel/tx/services/MatchV2Service.java b/src/main/java/com/textkernel/tx/services/MatchV2Service.java
index caddeb82..2ebc0ac9 100644
--- a/src/main/java/com/textkernel/tx/services/MatchV2Service.java
+++ b/src/main/java/com/textkernel/tx/services/MatchV2Service.java
@@ -36,7 +36,11 @@
/** See {@link TxClient#searchMatchV2()} */
public class MatchV2Service extends ServiceBase {
- /** See {@link TxClient#searchMatchV2()} */
+ /**
+ * Do not use this. See {@link TxClient#searchMatchV2()}
+ * @param httpClient The http client for API calls
+ * @param settings environment settings
+ */
public MatchV2Service(OkHttpClient httpClient, EnvironmentSettings settings) {
super(httpClient, settings);
}
@@ -72,7 +76,7 @@ public AddCandidateResponse addCandidate(String documentId, ParsedResume resume,
/**
* Upload a job to the search and match V2 environment.
* @param documentId The id to use for the document
- * @param resume Parsed output from the Textkernel Job Parser
+ * @param job Parsed output from the Textkernel Job Parser
* @param roles (optional) The roles associated with the request. Defaults to ["All"] if none are provided.
* @param customFields (optional) A collection of custom fields represented as key-value pairs
* @return The API response body
diff --git a/src/main/java/com/textkernel/tx/services/ParserService.java b/src/main/java/com/textkernel/tx/services/ParserService.java
index ed23eb1b..61aff173 100644
--- a/src/main/java/com/textkernel/tx/services/ParserService.java
+++ b/src/main/java/com/textkernel/tx/services/ParserService.java
@@ -24,7 +24,11 @@
/** See {@link TxClient#parser()} */
public class ParserService extends ServiceBase {
- /** See {@link TxClient#parser()} */
+ /**
+ * Do not use this. See {@link TxClient#parser()}
+ * @param httpClient The http client for API calls
+ * @param settings environment settings
+ */
public ParserService(OkHttpClient httpClient, EnvironmentSettings settings) {
super(httpClient, settings);
}
diff --git a/src/main/java/com/textkernel/tx/services/SearchMatchService.java b/src/main/java/com/textkernel/tx/services/SearchMatchService.java
index 0c0ffb61..7cd5618b 100644
--- a/src/main/java/com/textkernel/tx/services/SearchMatchService.java
+++ b/src/main/java/com/textkernel/tx/services/SearchMatchService.java
@@ -58,7 +58,11 @@
/** See {@link TxClient#searchMatchV1()} */
public class SearchMatchService extends ServiceBase {
- /** See {@link TxClient#searchMatchV1()} */
+ /**
+ * Do not use this. See {@link TxClient#searchMatchV1()}
+ * @param httpClient The http client for API calls
+ * @param settings environment settings
+ */
public SearchMatchService(OkHttpClient httpClient, EnvironmentSettings settings) {
super(httpClient, settings);
}
diff --git a/src/main/java/com/textkernel/tx/services/SkillsIntelligenceService.java b/src/main/java/com/textkernel/tx/services/SkillsIntelligenceService.java
index 17f0a647..eab8da2f 100644
--- a/src/main/java/com/textkernel/tx/services/SkillsIntelligenceService.java
+++ b/src/main/java/com/textkernel/tx/services/SkillsIntelligenceService.java
@@ -64,7 +64,11 @@
/** See {@link TxClient#skillsIntelligence()} */
public class SkillsIntelligenceService extends ServiceBase {
- /** See {@link TxClient#skillsIntelligence()} */
+ /**
+ * Do not use this. See {@link TxClient#skillsIntelligence()}
+ * @param httpClient The http client for API calls
+ * @param settings environment settings
+ */
public SkillsIntelligenceService(OkHttpClient httpClient, EnvironmentSettings settings) {
super(httpClient, settings);
}