diff --git a/src/main/java/com/coveo/pushapiclient/ApiUrl.java b/src/main/java/com/coveo/pushapiclient/ApiUrl.java
index 55d1f27a..622f2b36 100644
--- a/src/main/java/com/coveo/pushapiclient/ApiUrl.java
+++ b/src/main/java/com/coveo/pushapiclient/ApiUrl.java
@@ -10,8 +10,10 @@
/**
* Private util class to extract dynamic parts from a API URL Handles extraction of identifiers and
- * platform URL from a source URL. @See https://docs.coveo.com/en/1546#push-api-url
- * https://docs.coveo.com/en/3295#stream-api-url
+ * platform URL from a source URL.
+ *
+ * @see Push API url
+ * @see Stream API url
*/
class ApiUrl {
private final String organizationId;
diff --git a/src/main/java/com/coveo/pushapiclient/BatchIdentity.java b/src/main/java/com/coveo/pushapiclient/BatchIdentity.java
index 710e0ee0..9608bf6c 100644
--- a/src/main/java/com/coveo/pushapiclient/BatchIdentity.java
+++ b/src/main/java/com/coveo/pushapiclient/BatchIdentity.java
@@ -4,7 +4,9 @@
import com.google.gson.JsonObject;
import java.util.List;
-/** See [Manage Batches of Security Identities](https://docs.coveo.com/en/55) */
+/**
+ * @see Manage Batches of Security Identities
+ */
public class BatchIdentity {
private List members;
diff --git a/src/main/java/com/coveo/pushapiclient/BatchIdentityRecord.java b/src/main/java/com/coveo/pushapiclient/BatchIdentityRecord.java
index f0670036..5e9a1909 100644
--- a/src/main/java/com/coveo/pushapiclient/BatchIdentityRecord.java
+++ b/src/main/java/com/coveo/pushapiclient/BatchIdentityRecord.java
@@ -2,7 +2,9 @@
import com.google.gson.JsonObject;
-/** See [BatchIdentityBody](https://docs.coveo.com/en/139#batchidentitybody) */
+/**
+ * @see BatchIdentityBody]
+ */
public class BatchIdentityRecord {
private JsonObject[] members;
diff --git a/src/main/java/com/coveo/pushapiclient/BatchUpdate.java b/src/main/java/com/coveo/pushapiclient/BatchUpdate.java
index c251fe5b..5fbe866b 100644
--- a/src/main/java/com/coveo/pushapiclient/BatchUpdate.java
+++ b/src/main/java/com/coveo/pushapiclient/BatchUpdate.java
@@ -4,7 +4,9 @@
import java.util.List;
import java.util.Objects;
-/** See [Manage Batches of Items in a Push Source](https://docs.coveo.com/en/90) */
+/**
+ * @see Manage Batches of Items in a Push Source
+ */
public class BatchUpdate {
private final List addOrUpdate;
diff --git a/src/main/java/com/coveo/pushapiclient/BatchUpdateRecord.java b/src/main/java/com/coveo/pushapiclient/BatchUpdateRecord.java
index f511d363..008f9df3 100644
--- a/src/main/java/com/coveo/pushapiclient/BatchUpdateRecord.java
+++ b/src/main/java/com/coveo/pushapiclient/BatchUpdateRecord.java
@@ -3,7 +3,9 @@
import com.google.gson.JsonObject;
import java.util.Arrays;
-/** See [BatchDocumentBody](https://docs.coveo.com/en/75/#batchdocumentbody) */
+/**
+ * @see BatchDocumentBody
+ */
public class BatchUpdateRecord {
private final JsonObject[] addOrUpdate;
diff --git a/src/main/java/com/coveo/pushapiclient/CatalogSource.java b/src/main/java/com/coveo/pushapiclient/CatalogSource.java
index 2bbb06eb..bba4dc47 100644
--- a/src/main/java/com/coveo/pushapiclient/CatalogSource.java
+++ b/src/main/java/com/coveo/pushapiclient/CatalogSource.java
@@ -15,7 +15,8 @@ public class CatalogSource implements StreamEnabledSource {
* @param platformClient
* @param name The name of the source to create
* @param sourceVisibility The security option that should be applied to the content of the
- * source. See [Content Security](https://docs.coveo.com/en/1779).
+ * source.
+ * @see Content Security
* @return
* @throws IOException
* @throws InterruptedException
diff --git a/src/main/java/com/coveo/pushapiclient/DocumentBuilder.java b/src/main/java/com/coveo/pushapiclient/DocumentBuilder.java
index e4ad3385..1417675d 100644
--- a/src/main/java/com/coveo/pushapiclient/DocumentBuilder.java
+++ b/src/main/java/com/coveo/pushapiclient/DocumentBuilder.java
@@ -29,8 +29,10 @@ public class DocumentBuilder {
private final Document document;
/**
- * @param uri the URI of the document. See {@link Document#uri}
- * @param title the title of the document. See {@link Document#title}
+ * @param uri the URI of the document.
+ * @see {@link Document#uri}
+ * @param title the title of the document.
+ * @see {@link Document#title}
*/
public DocumentBuilder(String uri, String title) {
this.document = new Document();
@@ -43,8 +45,9 @@ public Document getDocument() {
}
/**
- * Set the data of the document. See {@link Document#data}
+ * Set the data of the document.
*
+ * @see {@link Document#data}
* @param data
* @return
*/
@@ -54,8 +57,9 @@ public DocumentBuilder withData(String data) {
}
/**
- * Set the date of the document. See {@link Document#date}
+ * Set the date of the document.
*
+ * @see {@link Document#date}
* @param date
* @return
*/
@@ -66,8 +70,9 @@ public DocumentBuilder withDate(String date) {
}
/**
- * Set the date of the document. See {@link Document#date}
+ * Set the date of the document.
*
+ * @see {@link Document#date}
* @param date
* @return
*/
@@ -78,8 +83,9 @@ public DocumentBuilder withDate(Long date) {
}
/**
- * Set the date of the document. See {@link Document#date}
+ * Set the date of the document.
*
+ * @see {@link Document#date}
* @param date
* @return
*/
@@ -90,8 +96,9 @@ public DocumentBuilder withDate(Date date) {
}
/**
- * Set the date of the document. See {@link Document#date}
+ * Set the date of the document.
*
+ * @see {@link Document#date}
* @param date
* @return
*/
@@ -101,8 +108,9 @@ public DocumentBuilder withDate(DateTime date) {
}
/**
- * Set the modified date of the document. See {@link Document#modifiedDate}
+ * Set the modified date of the document.
*
+ * @see {@link Document#modifiedDate}
* @param date
* @return
*/
@@ -113,8 +121,9 @@ public DocumentBuilder withModifiedDate(String date) {
}
/**
- * Set the modified date of the document. See {@link Document#modifiedDate}
+ * Set the modified date of the document.
*
+ * @see {@link Document#modifiedDate}
* @param date
* @return
*/
@@ -125,8 +134,9 @@ public DocumentBuilder withModifiedDate(Long date) {
}
/**
- * Set the modified date of the document. See {@link Document#modifiedDate}
+ * Set the modified date of the document.
*
+ * @see {@link Document#modifiedDate}
* @param date
* @return
*/
@@ -136,8 +146,9 @@ public DocumentBuilder withModifiedDate(DateTime date) {
}
/**
- * Set the modified date of the document. See {@link Document#modifiedDate}
+ * Set the modified date of the document.
*
+ * @see {@link Document#modifiedDate}
* @param date
* @return
*/
@@ -148,8 +159,9 @@ public DocumentBuilder withModifiedDate(Date date) {
}
/**
- * Set the permanentID of the document. See {@link Document#permanentId}
+ * Set the permanentID of the document.
*
+ * @see {@link Document#permanentId}
* @param permanentId
* @return
*/
@@ -159,9 +171,9 @@ public DocumentBuilder withPermanentId(String permanentId) {
}
/**
- * Set the base64 encoded, compressed binary data of the document. See {@link
- * Document#compressedBinaryData}
+ * Set the base64 encoded, compressed binary data of the document.
*
+ * @see {@link Document#compressedBinaryData}
* @param compressedBinaryData
* @return
*/
@@ -171,9 +183,9 @@ public DocumentBuilder withCompressedBinaryData(CompressedBinaryData compressedB
}
/**
- * Set the file container file ID for the compressed binary data of the document. See {@link
- * Document#compressedBinaryDataFileId}
+ * Set the file container file ID for the compressed binary data of the document.
*
+ * @see {@link Document#compressedBinaryDataFileId}
* @param compressedBinaryDataFileId
* @return
*/
@@ -183,8 +195,9 @@ public DocumentBuilder withCompressedBinaryDataFileId(String compressedBinaryDat
}
/**
- * Set the file extension on the document. See {@link Document#fileExtension}
+ * Set the file extension on the document.
*
+ * @see {@link Document#fileExtension}
* @param fileExtension
* @return
*/
@@ -195,8 +208,9 @@ public DocumentBuilder withFileExtension(String fileExtension) {
}
/**
- * Set the parentID on the document. See {@link Document#parentId}
+ * Set the parentID on the document.
*
+ * @see {@link Document#parentId}
* @param parentID
* @return
*/
@@ -206,8 +220,9 @@ public DocumentBuilder withParentID(String parentID) {
}
/**
- * Set the clickableURI on the document. See {@link Document#clickableUri}
+ * Set the clickableURI on the document.
*
+ * @see {@link Document#clickableUri}
* @param clickableUri
* @return
*/
@@ -217,8 +232,9 @@ public DocumentBuilder withClickableUri(String clickableUri) {
}
/**
- * Set the author on the document. See {@link Document#author}
+ * Set the author on the document.
*
+ * @see {@link Document#author}
* @param author
* @return
*/
@@ -228,8 +244,9 @@ public DocumentBuilder withAuthor(String author) {
}
/**
- * Add a single metadata key and value pair on the document. See {@link Document#metadata}
+ * Add a single metadata key and value pair on the document.
*
+ * @see {@link Document#metadata}
* @param key
* @param metadataValue
* @return
@@ -240,8 +257,9 @@ public DocumentBuilder withMetadataValue(String key, String metadataValue) {
}
/**
- * Add a single metadata key and value pair on the document. See {@link Document#metadata}
+ * Add a single metadata key and value pair on the document.
*
+ * @see {@link Document#metadata}
* @param key
* @param metadataValue
* @return
@@ -252,8 +270,9 @@ public DocumentBuilder withMetadataValue(String key, String[] metadataValue) {
}
/**
- * Add a single metadata key and value pair on the document. See {@link Document#metadata}
+ * Add a single metadata key and value pair on the document.
*
+ * @see {@link Document#metadata}
* @param key
* @param metadataValue
* @return
@@ -264,8 +283,9 @@ public DocumentBuilder withMetadataValue(String key, Integer metadataValue) {
}
/**
- * Add a single metadata key and value pair on the document. See {@link Document#metadata}
+ * Add a single metadata key and value pair on the document.
*
+ * @see {@link Document#metadata}
* @param key
* @param metadataValue
* @return
@@ -276,8 +296,9 @@ public DocumentBuilder withMetadataValue(String key, Integer[] metadataValue) {
}
/**
- * Set metadata on the document. See {@link Document#metadata}
+ * Set metadata on the document.
*
+ * @see {@link Document#metadata}
* @param metadata
* @return
*/
@@ -287,8 +308,9 @@ public DocumentBuilder withMetadata(Map metadata) {
}
/**
- * Set allowed identities on the document. See {@link Document#permissions}
+ * Set allowed identities on the document.
*
+ * @see {@link Document#permissions}
* @param allowedPermissions
* @return
*/
@@ -298,8 +320,9 @@ public DocumentBuilder withAllowedPermissions(SecurityIdentityBuilder allowedPer
}
/**
- * Set denied identities on the document. See {@link Document#permissions}
+ * Set denied identities on the document.
*
+ * @see {@link Document#permissions}
* @param deniedPermissions
* @return
*/
@@ -309,8 +332,9 @@ public DocumentBuilder withDeniedPermissions(SecurityIdentityBuilder deniedPermi
}
/**
- * Set allowAnonymous for permissions on the document. See {@link Document#permissions}
+ * Set allowAnonymous for permissions on the document.
*
+ * @see {@link Document#permissions}
* @param allowAnonymous
* @return
*/
@@ -320,8 +344,9 @@ public DocumentBuilder withAllowAnonymousUsers(Boolean allowAnonymous) {
}
/**
- * Set the fully built out DocumentPermissions array. See {@Link Document#permissions}
+ * Set the fully built out DocumentPermissions array.
*
+ * @see {@Link Document#permissions}
* @param documentPermissions
* @return
*/
@@ -383,7 +408,8 @@ private void validateReservedMetadataKeyNames(String key) {
if (reservedKeynames.contains(key)) {
throw new RuntimeException(
String.format(
- "Cannot use %s as a metadata key: It is a reserved keynames. See https://docs.coveo.com/en/78/index-content/push-api-reference#json-document-reserved-key-names",
+ "Cannot use %s as a metadata key: It is a reserved keynames. See"
+ + " https://docs.coveo.com/en/78/index-content/push-api-reference#json-document-reserved-key-names",
key));
}
}
diff --git a/src/main/java/com/coveo/pushapiclient/FileContainer.java b/src/main/java/com/coveo/pushapiclient/FileContainer.java
index 57920c7b..d3105326 100644
--- a/src/main/java/com/coveo/pushapiclient/FileContainer.java
+++ b/src/main/java/com/coveo/pushapiclient/FileContainer.java
@@ -2,7 +2,9 @@
import java.util.Map;
-/** See [Creating a FileContainer](https://docs.coveo.com/en/43) */
+/**
+ * @see Creating a FileContainer
+ */
public class FileContainer {
public String uploadUri;
public String fileId;
diff --git a/src/main/java/com/coveo/pushapiclient/PlatformClient.java b/src/main/java/com/coveo/pushapiclient/PlatformClient.java
index ba28dc78..81a6c02a 100644
--- a/src/main/java/com/coveo/pushapiclient/PlatformClient.java
+++ b/src/main/java/com/coveo/pushapiclient/PlatformClient.java
@@ -22,7 +22,8 @@ public class PlatformClient {
* Construct a PlatformClient
*
* @param apiKey An apiKey capable of pushing documents and managing sources in a Coveo
- * organization. See [Manage API Keys](https://docs.coveo.com/en/1718).
+ * organization.
+ * @see Manage API Keys
* @param organizationId The Coveo Organization identifier.
*/
public PlatformClient(String apiKey, String organizationId) {
@@ -33,7 +34,8 @@ public PlatformClient(String apiKey, String organizationId) {
* Construct a PlatformClient
*
* @param apiKey An apiKey capable of pushing documents and managing sources in a Coveo
- * organization. See [Manage API Keys](https://docs.coveo.com/en/1718).
+ * organization.
+ * @see Manage API Keys
* @param organizationId The Coveo Organization identifier.
* @param platformUrl The PlatformUrl.
*/
@@ -48,7 +50,8 @@ public PlatformClient(String apiKey, String organizationId, PlatformUrl platform
* Construct a PlatformClient
*
* @param apiKey An apiKey capable of pushing documents and managing sources in a Coveo
- * organization. See [Manage API Keys](https://docs.coveo.com/en/1718).
+ * organization.
+ * @see Manage API Keys
* @param organizationId The Coveo Organization identifier.
* @param httpClient The HttpClient.
*/
@@ -63,7 +66,8 @@ public PlatformClient(String apiKey, String organizationId, HttpClient httpClien
* @deprecated Please now use PlatformUrl to define your Platform environment
* @see PlatformUrl Construct a PlatformUrl
* @param apiKey An apiKey capable of pushing documents and managing sources in a Coveo
- * organization. See [Manage API Keys](https://docs.coveo.com/en/1718).
+ * organization.
+ * @see Manage API Keys
* @param organizationId The Coveo Organization identifier.
* @param environment The Environment to be used.
*/
@@ -98,7 +102,8 @@ public HttpResponse createSource(String name, SourceVisibility sourceVis
* @param name The name of the source to create
* @param sourceType The type of the source to create
* @param sourceVisibility The security option that should be applied to the content of the
- * source. See [Content Security](https://docs.coveo.com/en/1779).
+ * source.
+ * @see Content Security
* @return
* @throws IOException
* @throws InterruptedException
@@ -132,10 +137,10 @@ public HttpResponse createSource(
}
/**
- * Create or update a security identity. See [Adding a Single Security
- * Identity](https://docs.coveo.com/en/167) and [Security Identity
- * Models](https://docs.coveo.com/en/139).
+ * Create or update a security identity.
*
+ * @see Adding a Single Security Identity
+ * @see Security Identity Models.
* @param securityProviderId
* @param securityIdentityModel
* @return
@@ -162,10 +167,10 @@ public HttpResponse createOrUpdateSecurityIdentity(
}
/**
- * Create or update a security identity alias. See [Adding a Single
- * Alias](https://docs.coveo.com/en/142) and [User Alias Definition
- * Examples](https://docs.coveo.com/en/46).
+ * Create or update a security identity alias.
*
+ * @see Adding a Single Alias
+ * @see User Alias Definition Examples
* @param securityProviderId
* @param securityIdentityAlias
* @return
@@ -192,9 +197,9 @@ public HttpResponse createOrUpdateSecurityIdentityAlias(
}
/**
- * Delete a security identity. See [Disabling a Single Security
- * Identity](https://docs.coveo.com/en/84).
+ * Delete a security identity.
*
+ * @see Disabling a Single Security Identity
* @param securityProviderId
* @param securityIdentityToDelete
* @return
@@ -221,9 +226,9 @@ public HttpResponse deleteSecurityIdentity(
}
/**
- * Delete old security identities. See [Disabling Old Security
- * Identities](https://docs.coveo.com/en/33).
+ * Delete old security identities.
*
+ * @see Disabling Old Security Identities
* @param securityProviderId
* @param batchDelete
* @return
@@ -261,9 +266,9 @@ public String appendOrderingId(long orderingId) {
}
/**
- * Manage batches of security identities. See [Manage Batches of Security
- * Identities](https://docs.coveo.com/en/55).
+ * Manage batches of security identities.
*
+ * @see Manage Batches of Security Identities
* @param securityProviderId
* @param batchConfig
* @return
@@ -293,9 +298,9 @@ public HttpResponse manageSecurityIdentities(
}
/**
- * Adds or updates an individual item in a push source. See [Adding a Single Item in a Push
- * Source](https://docs.coveo.com/en/133).
+ * Adds or updates an individual item in a push source.
*
+ * @see Adding a Single Item in a Push Source
* @param sourceId
* @param documentJSON
* @param documentId
@@ -328,8 +333,9 @@ public HttpResponse pushDocument(
/**
* Deletes a specific item from a Push source. Optionally, the child items of that item can also
- * be deleted. See [Deleting an Item in a Push Source](https://docs.coveo.com/en/171).
+ * be deleted.
*
+ * @see Deleting an Item in a Push Source
* @param sourceId
* @param documentId
* @param deleteChildren
@@ -411,8 +417,9 @@ public HttpResponse requireStreamChunk(String sourceId, String streamId)
}
/**
- * Create a file container. See [Creating a File Container](https://docs.coveo.com/en/43).
+ * Create a file container.
*
+ * @see Creating a File Container
* @return
* @throws IOException
* @throws InterruptedException
@@ -433,9 +440,9 @@ public HttpResponse createFileContainer() throws IOException, Interrupte
}
/**
- * Update the status of a Push source. See [Updating the Status of a Push
- * Source](https://docs.coveo.com/en/35).
+ * Update the status of a Push source.
*
+ * @see Updating the Status of a Push Source
* @param status
* @return
* @throws IOException
@@ -461,9 +468,11 @@ public HttpResponse updateSourceStatus(String sourceId, PushAPIStatus st
}
/**
- * Upload content update into a file container. See [Upload the Content Update into the File
- * Container](https://docs.coveo.com/en/90/index-content/manage-batches-of-items-in-a-push-source#step-2-upload-the-content-update-into-the-file-container).
+ * Upload content update into a file container.
*
+ * @see Upload
+ * the Content Update into the File Container
* @param fileContainer
* @param batchUpdateJson
* @return
@@ -490,9 +499,11 @@ public HttpResponse uploadContentToFileContainer(
}
/**
- * Push a file container into a push source. See [Push the File Container into a Push
- * Source](https://docs.coveo.com/en/90/index-content/manage-batches-of-items-in-a-push-source#step-3-push-the-file-container-into-a-push-source).
+ * Push a file container into a push source.
*
+ * @see Push
+ * the File Container into a Push Source
* @param sourceId
* @param fileContainer
* @return
@@ -520,9 +531,11 @@ public HttpResponse pushFileContainerContent(String sourceId, FileContai
}
/**
- * Push a binary to a File Container. See [Upload the Item Data Into the File
- * Container](https://docs.coveo.com/en/69#step-2-upload-the-item-data-into-the-file-container)
+ * Push a binary to a File Container.
*
+ * @see Upload
+ * the Item Data Into the File Container
* @param fileContainer
* @param fileAsBytes
* @return
diff --git a/src/main/java/com/coveo/pushapiclient/PlatformUrl.java b/src/main/java/com/coveo/pushapiclient/PlatformUrl.java
index 7062dc11..9ca0042c 100644
--- a/src/main/java/com/coveo/pushapiclient/PlatformUrl.java
+++ b/src/main/java/com/coveo/pushapiclient/PlatformUrl.java
@@ -11,7 +11,7 @@ public class PlatformUrl {
/**
* @param environment The environment platform of your organization
* @param region The physical center of your organization
- * @see https://docs.coveo.com/en/2976
+ * @see Deployment regions and strategies
*/
public PlatformUrl(Environment environment, Region region) {
this.environment = environment;
diff --git a/src/main/java/com/coveo/pushapiclient/PushAPIStatus.java b/src/main/java/com/coveo/pushapiclient/PushAPIStatus.java
index ad1adacb..7efbd41b 100644
--- a/src/main/java/com/coveo/pushapiclient/PushAPIStatus.java
+++ b/src/main/java/com/coveo/pushapiclient/PushAPIStatus.java
@@ -1,8 +1,9 @@
package com.coveo.pushapiclient;
/**
- * Enum for possible PushAPI statuses. See [Updating the Status of a Push
- * Source](https://docs.coveo.com/en/35).
+ * Enum for possible PushAPI statuses.
+ *
+ * @see Updating the Status of a Push Source
*/
public enum PushAPIStatus {
IDLE,
diff --git a/src/main/java/com/coveo/pushapiclient/PushSource.java b/src/main/java/com/coveo/pushapiclient/PushSource.java
index 8e2075c1..1f3a8e28 100644
--- a/src/main/java/com/coveo/pushapiclient/PushSource.java
+++ b/src/main/java/com/coveo/pushapiclient/PushSource.java
@@ -39,7 +39,8 @@ public String getApiKey() {
* @param name
* @param name The name of the source to create
* @param sourceVisibility The security option that should be applied to the content of the
- * source. See [Content Security](https://docs.coveo.com/en/1779).
+ * source.
+ * @see Content Security
* @return
* @throws IOException
* @throws InterruptedException
@@ -132,10 +133,10 @@ private PushSource(
}
/**
- * Create or update a security identity. See [Adding a Single Security
- * Identity](https://docs.coveo.com/en/167) and [Security Identity
- * Models](https://docs.coveo.com/en/139).
+ * Create or update a security identity.
*
+ * @see Adding a Single Security Identity
+ * @see Security Identity Models
* @param securityProviderId
* @param securityIdentityModel
* @return
@@ -150,10 +151,10 @@ public HttpResponse createOrUpdateSecurityIdentity(
}
/**
- * Create or update a security identity alias. See [Adding a Single
- * Alias](https://docs.coveo.com/en/142) and [User Alias Definition
- * Examples](https://docs.coveo.com/en/46).
+ * Create or update a security identity alias.
*
+ * @see Adding a Single Alias
+ * @see User Alias Definition Examples
* @param securityProviderId
* @param securityIdentityAliasModel
* @return
@@ -168,9 +169,9 @@ public HttpResponse createOrUpdateSecurityIdentityAlias(
}
/**
- * Delete a security identity. See [Disabling a Single Security
- * Identity](https://docs.coveo.com/en/84).
+ * Delete a security identity.
*
+ * @see Disabling a Single Security Identity
* @param securityProviderId
* @param securityIdentityDelete
* @return
@@ -184,9 +185,9 @@ public HttpResponse deleteSecurityIdentity(
}
/**
- * Update the status of a Push source. See [Updating the Status of a Push
- * Source](https://docs.coveo.com/en/35).
+ * Update the status of a Push source.
*
+ * @see Updating the Status of a Push Source
* @param status
* @return
* @throws IOException
@@ -198,9 +199,9 @@ public HttpResponse updateSourceStatus(PushAPIStatus status)
}
/**
- * Delete old security identities. See [Disabling Old Security
- * Identities](https://docs.coveo.com/en/33).
+ * Delete old security identities.
*
+ * @see Disabling Old Security Identities
* @param securityProviderId
* @param batchDelete
* @return
@@ -214,9 +215,9 @@ public HttpResponse deleteOldSecurityIdentities(
}
/**
- * Manage batches of security identities. See [Manage Batches of Security
- * Identities](https://docs.coveo.com/en/55).
+ * Manage batches of security identities.
*
+ * @see Manage Batches of Security Identities
* @param securityProviderId
* @param batchConfig
* @return
@@ -230,9 +231,9 @@ public HttpResponse manageSecurityIdentities(
}
/**
- * Manages pushing batches of Security Identities to a File Container, then into Coveo. See
- * [Manage Batches of Security Identities](https://docs.coveo.com/en/55)
+ * Manages pushing batches of Security Identities to a File Container, then into Coveo.
*
+ * @see Manage Batches of Security Identities
* @param securityProviderId
* @param batchIdentity
* @return
@@ -260,9 +261,9 @@ public SecurityIdentityBatchResponse batchUpdateSecurityIdentities(
}
/**
- * Adds or updates an individual item in a push source. See [Adding a Single Item in a Push
- * Source](https://docs.coveo.com/en/133).
+ * Adds or updates an individual item in a push source.
*
+ * @see Adding a Single Item in a Push Source
* @param docBuilder
* @return
* @throws IOException
@@ -280,8 +281,9 @@ public HttpResponse addOrUpdateDocument(DocumentBuilder docBuilder)
/**
* Deletes a specific item from a Push source. Optionally, the child items of that item can also
- * be deleted. See [Deleting an Item in a Push Source](https://docs.coveo.com/en/171).
+ * be deleted.
*
+ * @see Deleting an Item in a Push Source
* @param documentId
* @param deleteChildren
* @return
diff --git a/src/main/java/com/coveo/pushapiclient/SecurityIdentityAliasModel.java b/src/main/java/com/coveo/pushapiclient/SecurityIdentityAliasModel.java
index 4d66a4a5..f738d5be 100644
--- a/src/main/java/com/coveo/pushapiclient/SecurityIdentityAliasModel.java
+++ b/src/main/java/com/coveo/pushapiclient/SecurityIdentityAliasModel.java
@@ -1,6 +1,8 @@
package com.coveo.pushapiclient;
-/** See [User Alias Definition Examples](https://docs.coveo.com/en/46). */
+/**
+ * @see User Alias Definition Examples
+ */
public class SecurityIdentityAliasModel extends SecurityIdentityModelBase {
public final AliasMapping[] mappings;
diff --git a/src/main/java/com/coveo/pushapiclient/SecurityIdentityBatchConfig.java b/src/main/java/com/coveo/pushapiclient/SecurityIdentityBatchConfig.java
index 74cb66b4..7451b92a 100644
--- a/src/main/java/com/coveo/pushapiclient/SecurityIdentityBatchConfig.java
+++ b/src/main/java/com/coveo/pushapiclient/SecurityIdentityBatchConfig.java
@@ -2,7 +2,9 @@
import java.util.Objects;
-/** See [Manage Batches of Security Identities](https://docs.coveo.com/en/55). */
+/**
+ * @see Manage Batches of Security Identities
+ */
public class SecurityIdentityBatchConfig {
private final String fileId;
diff --git a/src/main/java/com/coveo/pushapiclient/SecurityIdentityBatchResponse.java b/src/main/java/com/coveo/pushapiclient/SecurityIdentityBatchResponse.java
index f8f51848..d0063ba5 100644
--- a/src/main/java/com/coveo/pushapiclient/SecurityIdentityBatchResponse.java
+++ b/src/main/java/com/coveo/pushapiclient/SecurityIdentityBatchResponse.java
@@ -3,8 +3,9 @@
import java.net.http.HttpResponse;
/**
- * Used for the responses when pushing batches of Security Identities. See [Manage Batches of
- * Security Identities](https://docs.coveo.com/en/55)
+ * Used for the responses when pushing batches of Security Identities.
+ *
+ * @see Manage Batches of Security Identities
*/
public class SecurityIdentityBatchResponse {
diff --git a/src/main/java/com/coveo/pushapiclient/SecurityIdentityDelete.java b/src/main/java/com/coveo/pushapiclient/SecurityIdentityDelete.java
index 7df5c128..da955045 100644
--- a/src/main/java/com/coveo/pushapiclient/SecurityIdentityDelete.java
+++ b/src/main/java/com/coveo/pushapiclient/SecurityIdentityDelete.java
@@ -2,7 +2,9 @@
import java.util.Objects;
-/** See [Disabling a Single Security Identity](https://docs.coveo.com/en/84) */
+/**
+ * @see Disabling a Single Security Identity
+ */
public class SecurityIdentityDelete {
private final IdentityModel identity;
diff --git a/src/main/java/com/coveo/pushapiclient/SecurityIdentityDeleteOptions.java b/src/main/java/com/coveo/pushapiclient/SecurityIdentityDeleteOptions.java
index 21147653..78973119 100644
--- a/src/main/java/com/coveo/pushapiclient/SecurityIdentityDeleteOptions.java
+++ b/src/main/java/com/coveo/pushapiclient/SecurityIdentityDeleteOptions.java
@@ -2,7 +2,9 @@
import java.util.Objects;
-/** See [Disabling Old Security Identities](https://docs.coveo.com/en/33) */
+/**
+ * @see Disabling Old Security Identities
+ */
public class SecurityIdentityDeleteOptions {
private final Integer queueDelay;
diff --git a/src/main/java/com/coveo/pushapiclient/SecurityIdentityModel.java b/src/main/java/com/coveo/pushapiclient/SecurityIdentityModel.java
index 8cdaf7eb..5e691ba0 100644
--- a/src/main/java/com/coveo/pushapiclient/SecurityIdentityModel.java
+++ b/src/main/java/com/coveo/pushapiclient/SecurityIdentityModel.java
@@ -1,6 +1,8 @@
package com.coveo.pushapiclient;
-/** See [Security Identity Models](https://docs.coveo.com/en/139) */
+/**
+ * @see Security Identity Models
+ */
public class SecurityIdentityModel extends SecurityIdentityModelBase {
public final IdentityModel[] members;
diff --git a/src/main/java/com/coveo/pushapiclient/Source.java b/src/main/java/com/coveo/pushapiclient/Source.java
index 36772c12..a9099ff8 100644
--- a/src/main/java/com/coveo/pushapiclient/Source.java
+++ b/src/main/java/com/coveo/pushapiclient/Source.java
@@ -10,7 +10,8 @@ public class Source {
/**
* @param apiKey An apiKey capable of pushing documents and managing sources in a Coveo
- * organization. See [Manage API Keys](https://docs.coveo.com/en/1718).
+ * organization.
+ * @see Manage API Keys.
* @param organizationId The Coveo Organization identifier.
*/
public Source(String apiKey, String organizationId) {
@@ -19,7 +20,8 @@ public Source(String apiKey, String organizationId) {
/**
* @param apiKey An apiKey capable of pushing documents and managing sources in a Coveo
- * organization. See [Manage API Keys](https://docs.coveo.com/en/1718).
+ * organization.
+ * @see Manage API Keys.
* @param organizationId The Coveo Organization identifier.
* @param platformUrl
*/
@@ -31,7 +33,8 @@ public Source(String apiKey, String organizationId, PlatformUrl platformUrl) {
* @deprecated Please now use PlatformUrl to define your Platform environment
* @see PlatformUrl Construct a PlatformUrl
* @param apiKey An apiKey capable of pushing documents and managing sources in a Coveo
- * organization. See [Manage API Keys](https://docs.coveo.com/en/1718).
+ * organization.
+ * @see Manage API Keys.
* @param organizationId The Coveo Organization identifier.
* @param environment The Environment to be used.
*/
@@ -45,7 +48,8 @@ public Source(String apiKey, String organizationId, Environment environment) {
*
* @param name The name of the source to create
* @param sourceVisibility The security option that should be applied to the content of the
- * source. See [Content Security](https://docs.coveo.com/en/1779).
+ * source.
+ * @see Content Security
* @return
* @throws IOException
* @throws InterruptedException
@@ -56,10 +60,10 @@ public HttpResponse create(String name, SourceVisibility sourceVisibilit
}
/**
- * Create or update a security identity. See [Adding a Single Security
- * Identity](https://docs.coveo.com/en/167) and [Security Identity
- * Models](https://docs.coveo.com/en/139).
+ * Create or update a security identity.
*
+ * @see Adding a Single Security Identity
+ * @see Security Identity Models
* @param securityProviderId
* @param securityIdentityModel
* @return
@@ -74,10 +78,10 @@ public HttpResponse createOrUpdateSecurityIdentity(
}
/**
- * Create or update a security identity alias. See [Adding a Single
- * Alias](https://docs.coveo.com/en/142) and [User Alias Definition
- * Examples](https://docs.coveo.com/en/46).
+ * Create or update a security identity alias.
*
+ * @see Adding a Single Alias
+ * @see User Alias Definition Examples
* @param securityProviderId
* @param securityIdentityAliasModel
* @return
@@ -92,9 +96,9 @@ public HttpResponse createOrUpdateSecurityIdentityAlias(
}
/**
- * Delete a security identity. See [Disabling a Single Security
- * Identity](https://docs.coveo.com/en/84).
+ * Delete a security identity.
*
+ * @see Disabling a Single Security Identity
* @param securityProviderId
* @param securityIdentityDelete
* @return
@@ -108,9 +112,9 @@ public HttpResponse deleteSecurityIdentity(
}
/**
- * Update the status of a Push source. See [Updating the Status of a Push
- * Source](https://docs.coveo.com/en/35).
+ * Update the status of a Push source.
*
+ * @see Updating the Status of a Push Source
* @param sourceId
* @param status
* @return
@@ -123,9 +127,9 @@ public HttpResponse updateSourceStatus(String sourceId, PushAPIStatus st
}
/**
- * Delete old security identities. See [Disabling Old Security
- * Identities](https://docs.coveo.com/en/33).
+ * Delete old security identities.
*
+ * @see Disabling Old Security Identities
* @param securityProviderId
* @param batchDelete
* @return
@@ -139,9 +143,9 @@ public HttpResponse deleteOldSecurityIdentities(
}
/**
- * Manage batches of security identities. See [Manage Batches of Security
- * Identities](https://docs.coveo.com/en/55).
+ * Manage batches of security identities.
*
+ * @see Manage Batches of Security Identities
* @param securityProviderId
* @param batchConfig
* @return
@@ -155,9 +159,9 @@ public HttpResponse manageSecurityIdentities(
}
/**
- * Adds or updates an individual item in a push source. See [Adding a Single Item in a Push
- * Source](https://docs.coveo.com/en/133).
+ * Adds or updates an individual item in a push source.
*
+ * @see Adding a Single Item in a Push Source
* @param sourceId
* @param docBuilder
* @return
@@ -176,8 +180,9 @@ public HttpResponse addOrUpdateDocument(String sourceId, DocumentBuilder
/**
* Deletes a specific item from a Push source. Optionally, the child items of that item can also
- * be deleted. See [Deleting an Item in a Push Source](https://docs.coveo.com/en/171).
+ * be deleted.
*
+ * @see Deleting an Item in a Push Source
* @param sourceId
* @param documentId
* @param deleteChildren
@@ -192,9 +197,9 @@ public HttpResponse deleteDocument(
}
/**
- * Manage batches of items in a push source. See [Manage Batches of Items in a Push
- * Source](https://docs.coveo.com/en/90)
+ * Manage batches of items in a push source.
*
+ * @see Manage Batches of Items in a Push Source
* @param sourceId
* @param batchUpdate
* @return
@@ -211,9 +216,9 @@ public HttpResponse batchUpdateDocuments(String sourceId, BatchUpdate ba
}
/**
- * Manages pushing batches of Security Identities to a File Container, then into Coveo. See
- * [Manage Batches of Security Identities](https://docs.coveo.com/en/55)
+ * Manages pushing batches of Security Identities to a File Container, then into Coveo.
*
+ * @see Manage Batches of Security Identities
* @param securityProviderId
* @param batchIdentity
* @return
@@ -241,8 +246,9 @@ public SecurityIdentityBatchResponse batchUpdateSecurityIdentities(
}
/**
- * Creates a File Container. [Creating a File Container](https://docs.coveo.com/en/43)
+ * Creates a File Container.
*
+ * @see Creating a File Container
* @return
* @throws IOException
* @throws InterruptedException
@@ -253,9 +259,9 @@ public FileContainer createFileContainer() throws IOException, InterruptedExcept
}
/**
- * Push file to a File Container. [Using the compressedBinaryDataFileId
- * Property](https://docs.coveo.com/en/69)
+ * Push file to a File Container.
*
+ * @see Using the compressedBinaryDataFileId Property
* @param fileContainer
* @param fileAsBytes
* @return
diff --git a/src/main/java/com/coveo/pushapiclient/SourceVisibility.java b/src/main/java/com/coveo/pushapiclient/SourceVisibility.java
index bedaa299..02490143 100644
--- a/src/main/java/com/coveo/pushapiclient/SourceVisibility.java
+++ b/src/main/java/com/coveo/pushapiclient/SourceVisibility.java
@@ -2,7 +2,7 @@
/**
* SourceVisibility controls the content security option that should be applied to the items in a
- * source. See https://docs.coveo.com/en/1779/index-content/content-security
+ * source. Content Security
*/
public enum SourceVisibility {
/** Items can be accessed by the source owner only. */