diff --git a/build.gradle b/build.gradle
index 6209aeff644..17d4bc864ca 100644
--- a/build.gradle
+++ b/build.gradle
@@ -278,6 +278,7 @@ allprojects {
// see https://discuss.gradle.org/t/add-custom-javadoc-option-that-does-not-take-an-argument/5959
javadoc.options.encoding = 'UTF8'
javadoc.options.addStringOption('Xdoclint:all,-missing', '-quiet')
+ javadoc.options.tags = ["opensearch.internal", "opensearch.api", "opensearch.experimental"]
}
// support for reproducible builds
@@ -387,7 +388,7 @@ gradle.projectsEvaluated {
}
}
}
-
+
dependencies {
subprojects.findAll { it.pluginManager.hasPlugin('java') }.forEach {
testReportAggregation it
@@ -413,7 +414,7 @@ subprojects {
// eclipse configuration
allprojects {
apply plugin: 'eclipse'
-
+
// Name all the non-root projects after their path so that paths get grouped together when imported into eclipse.
if (path != ':') {
eclipse.project.name = path
@@ -573,12 +574,12 @@ subprojects {
reporting {
reports {
- testAggregateTestReport(AggregateTestReport) {
+ testAggregateTestReport(AggregateTestReport) {
testType = TestSuiteType.UNIT_TEST
}
}
}
tasks.named(JavaBasePlugin.CHECK_TASK_NAME) {
- dependsOn tasks.named('testAggregateTestReport', TestReport)
+ dependsOn tasks.named('testAggregateTestReport', TestReport)
}
diff --git a/server/src/main/java/org/opensearch/bootstrap/Bootstrap.java b/server/src/main/java/org/opensearch/bootstrap/Bootstrap.java
index c0c0251538d..8c4a550a9b5 100644
--- a/server/src/main/java/org/opensearch/bootstrap/Bootstrap.java
+++ b/server/src/main/java/org/opensearch/bootstrap/Bootstrap.java
@@ -82,6 +82,8 @@ import java.util.concurrent.TimeUnit;
/**
* Internal startup code.
+ *
+ * @opensearch.internal
*/
final class Bootstrap {
diff --git a/server/src/main/java/org/opensearch/bootstrap/BootstrapCheck.java b/server/src/main/java/org/opensearch/bootstrap/BootstrapCheck.java
index 230b1bd05e5..429612ba1b9 100644
--- a/server/src/main/java/org/opensearch/bootstrap/BootstrapCheck.java
+++ b/server/src/main/java/org/opensearch/bootstrap/BootstrapCheck.java
@@ -36,6 +36,8 @@ import java.util.Objects;
/**
* Encapsulates a bootstrap check.
+ *
+ * @opensearch.internal
*/
public interface BootstrapCheck {
diff --git a/server/src/main/java/org/opensearch/bootstrap/BootstrapChecks.java b/server/src/main/java/org/opensearch/bootstrap/BootstrapChecks.java
index 6b75f230643..7953dee644e 100644
--- a/server/src/main/java/org/opensearch/bootstrap/BootstrapChecks.java
+++ b/server/src/main/java/org/opensearch/bootstrap/BootstrapChecks.java
@@ -71,6 +71,8 @@ import static org.opensearch.discovery.SettingsBasedSeedHostsProvider.DISCOVERY_
* We enforce bootstrap checks once a node has the transport protocol bound to a non-loopback interface or if the system property {@code
* opensearch.enforce.bootstrap.checks} is set to {@true}. In this case we assume the node is running in production and
* all bootstrap checks must pass.
+ *
+ * @opensearch.internal
*/
final class BootstrapChecks {
diff --git a/server/src/main/java/org/opensearch/bootstrap/BootstrapContext.java b/server/src/main/java/org/opensearch/bootstrap/BootstrapContext.java
index b07a544e852..1cfd8bf6dfc 100644
--- a/server/src/main/java/org/opensearch/bootstrap/BootstrapContext.java
+++ b/server/src/main/java/org/opensearch/bootstrap/BootstrapContext.java
@@ -37,6 +37,8 @@ import org.opensearch.env.Environment;
/**
* Context that is passed to every bootstrap check to make decisions on.
+ *
+ * @opensearch.internal
*/
public class BootstrapContext {
/**
diff --git a/server/src/main/java/org/opensearch/bootstrap/BootstrapException.java b/server/src/main/java/org/opensearch/bootstrap/BootstrapException.java
index 8daa29aa357..77b66553cb4 100644
--- a/server/src/main/java/org/opensearch/bootstrap/BootstrapException.java
+++ b/server/src/main/java/org/opensearch/bootstrap/BootstrapException.java
@@ -41,6 +41,8 @@ import java.nio.file.Path;
* these checked exceptions so that
* {@link Bootstrap#init(boolean, Path, boolean, org.opensearch.env.Environment)}
* does not have to declare all of these checked exceptions.
+ *
+ * @opensearch.internal
*/
class BootstrapException extends Exception {
diff --git a/server/src/main/java/org/opensearch/bootstrap/BootstrapInfo.java b/server/src/main/java/org/opensearch/bootstrap/BootstrapInfo.java
index d45d8ddab9c..0aa965ce460 100644
--- a/server/src/main/java/org/opensearch/bootstrap/BootstrapInfo.java
+++ b/server/src/main/java/org/opensearch/bootstrap/BootstrapInfo.java
@@ -39,6 +39,8 @@ import java.util.Enumeration;
/**
* Exposes system startup information
+ *
+ * @opensearch.internal
*/
@SuppressForbidden(reason = "exposes read-only view of system properties")
public final class BootstrapInfo {
diff --git a/server/src/main/java/org/opensearch/bootstrap/BootstrapSettings.java b/server/src/main/java/org/opensearch/bootstrap/BootstrapSettings.java
index 208030b5d6d..911bc92c433 100644
--- a/server/src/main/java/org/opensearch/bootstrap/BootstrapSettings.java
+++ b/server/src/main/java/org/opensearch/bootstrap/BootstrapSettings.java
@@ -35,6 +35,11 @@ package org.opensearch.bootstrap;
import org.opensearch.common.settings.Setting;
import org.opensearch.common.settings.Setting.Property;
+/**
+ * Settings used for bootstrapping OpenSearch
+ *
+ * @opensearch.internal
+ */
public final class BootstrapSettings {
private BootstrapSettings() {}
diff --git a/server/src/main/java/org/opensearch/bootstrap/ConsoleCtrlHandler.java b/server/src/main/java/org/opensearch/bootstrap/ConsoleCtrlHandler.java
index cbc1b6e7619..ae9b6ea7ce7 100644
--- a/server/src/main/java/org/opensearch/bootstrap/ConsoleCtrlHandler.java
+++ b/server/src/main/java/org/opensearch/bootstrap/ConsoleCtrlHandler.java
@@ -32,6 +32,11 @@
package org.opensearch.bootstrap;
+/**
+ * Handler for ctrl events on the console
+ *
+ * @opensearch.internal
+ */
public interface ConsoleCtrlHandler {
int CTRL_CLOSE_EVENT = 2;
diff --git a/server/src/main/java/org/opensearch/bootstrap/FilePermissionUtils.java b/server/src/main/java/org/opensearch/bootstrap/FilePermissionUtils.java
index b37aef5f973..18ff013b1e8 100644
--- a/server/src/main/java/org/opensearch/bootstrap/FilePermissionUtils.java
+++ b/server/src/main/java/org/opensearch/bootstrap/FilePermissionUtils.java
@@ -40,6 +40,11 @@ import java.nio.file.Files;
import java.nio.file.Path;
import java.security.Permissions;
+/**
+ * Utility for File Permissions during bootstrap
+ *
+ * @opensearch.internal
+ */
public class FilePermissionUtils {
/** no instantiation */
diff --git a/server/src/main/java/org/opensearch/bootstrap/JNACLibrary.java b/server/src/main/java/org/opensearch/bootstrap/JNACLibrary.java
index 7d3ce7728a9..aca2cb96560 100644
--- a/server/src/main/java/org/opensearch/bootstrap/JNACLibrary.java
+++ b/server/src/main/java/org/opensearch/bootstrap/JNACLibrary.java
@@ -45,6 +45,8 @@ import java.util.List;
/**
* java mapping to some libc functions
+ *
+ * @opensearch.internal
*/
final class JNACLibrary {
diff --git a/server/src/main/java/org/opensearch/bootstrap/JNAKernel32Library.java b/server/src/main/java/org/opensearch/bootstrap/JNAKernel32Library.java
index a0cd656f5fc..8e556df4b2f 100644
--- a/server/src/main/java/org/opensearch/bootstrap/JNAKernel32Library.java
+++ b/server/src/main/java/org/opensearch/bootstrap/JNAKernel32Library.java
@@ -51,6 +51,8 @@ import java.util.List;
/**
* Library for Windows/Kernel32
+ *
+ * @opensearch.internal
*/
final class JNAKernel32Library {
diff --git a/server/src/main/java/org/opensearch/bootstrap/JNANatives.java b/server/src/main/java/org/opensearch/bootstrap/JNANatives.java
index 1e3c6c3af03..033596033b0 100644
--- a/server/src/main/java/org/opensearch/bootstrap/JNANatives.java
+++ b/server/src/main/java/org/opensearch/bootstrap/JNANatives.java
@@ -48,6 +48,8 @@ import static org.opensearch.bootstrap.JNAKernel32Library.SizeT;
/**
* This class performs the actual work with JNA and library bindings to call native methods. It should only be used after
* we are sure that the JNA classes are available to the JVM
+ *
+ * @opensearch.internal
*/
class JNANatives {
diff --git a/server/src/main/java/org/opensearch/bootstrap/Natives.java b/server/src/main/java/org/opensearch/bootstrap/Natives.java
index 65025e41958..aa5e29fbb25 100644
--- a/server/src/main/java/org/opensearch/bootstrap/Natives.java
+++ b/server/src/main/java/org/opensearch/bootstrap/Natives.java
@@ -40,6 +40,8 @@ import java.nio.file.Path;
/**
* The Natives class is a wrapper class that checks if the classes necessary for calling native methods are available on
* startup. If they are not available, this class will avoid calling code that loads these classes.
+ *
+ * @opensearch.internal
*/
final class Natives {
/** no instantiation */
diff --git a/server/src/main/java/org/opensearch/bootstrap/OpenSearch.java b/server/src/main/java/org/opensearch/bootstrap/OpenSearch.java
index 7f96ea425d1..ab52ae5a43a 100644
--- a/server/src/main/java/org/opensearch/bootstrap/OpenSearch.java
+++ b/server/src/main/java/org/opensearch/bootstrap/OpenSearch.java
@@ -55,6 +55,8 @@ import java.util.Locale;
/**
* This class starts opensearch.
+ *
+ * @opensearch.internal
*/
class OpenSearch extends EnvironmentAwareCommand {
diff --git a/server/src/main/java/org/opensearch/bootstrap/OpenSearchPolicy.java b/server/src/main/java/org/opensearch/bootstrap/OpenSearchPolicy.java
index d31f11f153a..14435db6427 100644
--- a/server/src/main/java/org/opensearch/bootstrap/OpenSearchPolicy.java
+++ b/server/src/main/java/org/opensearch/bootstrap/OpenSearchPolicy.java
@@ -48,7 +48,11 @@ import java.util.Collections;
import java.util.Map;
import java.util.function.Predicate;
-/** custom policy for union of static and dynamic permissions */
+/**
+ * custom policy for union of static and dynamic permissions
+ *
+ * @opensearch.internal
+ **/
final class OpenSearchPolicy extends Policy {
/** template policy file, the one used in tests */
diff --git a/server/src/main/java/org/opensearch/bootstrap/OpenSearchUncaughtExceptionHandler.java b/server/src/main/java/org/opensearch/bootstrap/OpenSearchUncaughtExceptionHandler.java
index 4834f4cb211..2b28260097c 100644
--- a/server/src/main/java/org/opensearch/bootstrap/OpenSearchUncaughtExceptionHandler.java
+++ b/server/src/main/java/org/opensearch/bootstrap/OpenSearchUncaughtExceptionHandler.java
@@ -41,6 +41,11 @@ import java.io.IOError;
import java.security.AccessController;
import java.security.PrivilegedAction;
+/**
+ * UncaughtException Handler used during bootstrapping
+ *
+ * @opensearch.internal
+ */
class OpenSearchUncaughtExceptionHandler implements Thread.UncaughtExceptionHandler {
private static final Logger logger = LogManager.getLogger(OpenSearchUncaughtExceptionHandler.class);
diff --git a/server/src/main/java/org/opensearch/bootstrap/Security.java b/server/src/main/java/org/opensearch/bootstrap/Security.java
index 59ca91a68e0..749c146de4f 100644
--- a/server/src/main/java/org/opensearch/bootstrap/Security.java
+++ b/server/src/main/java/org/opensearch/bootstrap/Security.java
@@ -116,6 +116,8 @@ import static org.opensearch.bootstrap.FilePermissionUtils.addSingleFilePath;
*
* See
* Troubleshooting Security for information.
+ *
+ * @opensearch.internal
*/
final class Security {
/** no instantiation */
diff --git a/server/src/main/java/org/opensearch/bootstrap/Spawner.java b/server/src/main/java/org/opensearch/bootstrap/Spawner.java
index e2fae1f1964..e2df60af6c1 100644
--- a/server/src/main/java/org/opensearch/bootstrap/Spawner.java
+++ b/server/src/main/java/org/opensearch/bootstrap/Spawner.java
@@ -51,6 +51,8 @@ import java.util.concurrent.atomic.AtomicBoolean;
/**
* Spawns native module controller processes if present. Will only work prior to a system call filter being installed.
+ *
+ * @opensearch.internal
*/
final class Spawner implements Closeable {
diff --git a/server/src/main/java/org/opensearch/bootstrap/StartupException.java b/server/src/main/java/org/opensearch/bootstrap/StartupException.java
index 735e8cfd287..9ad89ab5180 100644
--- a/server/src/main/java/org/opensearch/bootstrap/StartupException.java
+++ b/server/src/main/java/org/opensearch/bootstrap/StartupException.java
@@ -44,6 +44,8 @@ import java.util.function.Consumer;
* "reasonably". This means limits on stacktrace frames and
* cleanup for guice, and some guidance about consulting full
* logs for the whole exception.
+ *
+ * @opensearch.internal
*/
// TODO: remove this when guice is removed, and exceptions are cleaned up
// this is horrible, but its what we must do
diff --git a/server/src/main/java/org/opensearch/bootstrap/SystemCallFilter.java b/server/src/main/java/org/opensearch/bootstrap/SystemCallFilter.java
index 8e179de9c28..f8baee06c43 100644
--- a/server/src/main/java/org/opensearch/bootstrap/SystemCallFilter.java
+++ b/server/src/main/java/org/opensearch/bootstrap/SystemCallFilter.java
@@ -102,6 +102,8 @@ import java.util.Map;
* https://reverse.put.as/wp-content/uploads/2011/06/The-Apple-Sandbox-BHDC2011-Paper.pdf
* @see
* https://docs.oracle.com/cd/E23824_01/html/821-1456/prbac-2.html
+ *
+ * @opensearch.internal
*/
// not an example of how to write code!!!
final class SystemCallFilter {
diff --git a/server/src/main/java/org/opensearch/cli/CommandLoggingConfigurator.java b/server/src/main/java/org/opensearch/cli/CommandLoggingConfigurator.java
index 1705e9ebdd4..89187254721 100644
--- a/server/src/main/java/org/opensearch/cli/CommandLoggingConfigurator.java
+++ b/server/src/main/java/org/opensearch/cli/CommandLoggingConfigurator.java
@@ -39,6 +39,8 @@ import org.opensearch.common.settings.Settings;
/**
* Holder class for method to configure logging without OpenSearch configuration files for use in CLI tools that will not read such
* files.
+ *
+ * @opensearch.internal
*/
public final class CommandLoggingConfigurator {
diff --git a/server/src/main/java/org/opensearch/cli/EnvironmentAwareCommand.java b/server/src/main/java/org/opensearch/cli/EnvironmentAwareCommand.java
index e85af87213f..10c59ef6730 100644
--- a/server/src/main/java/org/opensearch/cli/EnvironmentAwareCommand.java
+++ b/server/src/main/java/org/opensearch/cli/EnvironmentAwareCommand.java
@@ -46,7 +46,11 @@ import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
-/** A cli command which requires an {@link org.opensearch.env.Environment} to use current paths and settings. */
+/**
+ * A cli command which requires an {@link org.opensearch.env.Environment} to use current paths and settings.
+ *
+ * @opensearch.internal
+ */
public abstract class EnvironmentAwareCommand extends Command {
private final OptionSpec settingOption;
diff --git a/server/src/main/java/org/opensearch/cli/KeyStoreAwareCommand.java b/server/src/main/java/org/opensearch/cli/KeyStoreAwareCommand.java
index 404dacd504e..17067909315 100644
--- a/server/src/main/java/org/opensearch/cli/KeyStoreAwareCommand.java
+++ b/server/src/main/java/org/opensearch/cli/KeyStoreAwareCommand.java
@@ -44,6 +44,8 @@ import java.util.Arrays;
/**
* An {@link org.opensearch.cli.EnvironmentAwareCommand} that needs to access the opensearch keystore, possibly
* decrypting it if it is password protected.
+ *
+ * @opensearch.internal
*/
public abstract class KeyStoreAwareCommand extends EnvironmentAwareCommand {
public KeyStoreAwareCommand(String description) {
diff --git a/server/src/main/java/org/opensearch/cli/LoggingAwareCommand.java b/server/src/main/java/org/opensearch/cli/LoggingAwareCommand.java
index 7aee5e3fa1f..07a6b7d523a 100644
--- a/server/src/main/java/org/opensearch/cli/LoggingAwareCommand.java
+++ b/server/src/main/java/org/opensearch/cli/LoggingAwareCommand.java
@@ -35,6 +35,8 @@ package org.opensearch.cli;
/**
* A command that is aware of logging. This class should be preferred over the base {@link Command} class for any CLI tools that depend on
* core OpenSearch as they could directly or indirectly touch classes that touch logging and as such logging needs to be configured.
+ *
+ * @opensearch.internal
*/
public abstract class LoggingAwareCommand extends Command {
diff --git a/server/src/main/java/org/opensearch/cli/LoggingAwareMultiCommand.java b/server/src/main/java/org/opensearch/cli/LoggingAwareMultiCommand.java
index 2354a4978ae..8453ed05a12 100644
--- a/server/src/main/java/org/opensearch/cli/LoggingAwareMultiCommand.java
+++ b/server/src/main/java/org/opensearch/cli/LoggingAwareMultiCommand.java
@@ -36,6 +36,8 @@ package org.opensearch.cli;
* A multi-command that is aware of logging. This class should be preferred over the base {@link MultiCommand} class for any CLI tools that
* depend on core OpenSearch as they could directly or indirectly touch classes that touch logging and as such logging needs to be
* configured.
+ *
+ * @opensearch.internal
*/
public abstract class LoggingAwareMultiCommand extends MultiCommand {
diff --git a/server/src/main/java/org/opensearch/client/AdminClient.java b/server/src/main/java/org/opensearch/client/AdminClient.java
index 995466ba574..0c6c97b7959 100644
--- a/server/src/main/java/org/opensearch/client/AdminClient.java
+++ b/server/src/main/java/org/opensearch/client/AdminClient.java
@@ -35,8 +35,9 @@ package org.opensearch.client;
/**
* Administrative actions/operations against the cluster or the indices.
*
- *
* @see org.opensearch.client.Client#admin()
+ *
+ * @opensearch.internal
*/
public interface AdminClient {
diff --git a/server/src/main/java/org/opensearch/client/Client.java b/server/src/main/java/org/opensearch/client/Client.java
index bca68834ca3..50f8f522538 100644
--- a/server/src/main/java/org/opensearch/client/Client.java
+++ b/server/src/main/java/org/opensearch/client/Client.java
@@ -93,6 +93,8 @@ import java.util.Map;
* A client can be retrieved from a started {@link org.opensearch.node.Node}.
*
* @see org.opensearch.node.Node#client()
+ *
+ * @opensearch.internal
*/
public interface Client extends OpenSearchClient, Releasable {
diff --git a/server/src/main/java/org/opensearch/client/ClusterAdminClient.java b/server/src/main/java/org/opensearch/client/ClusterAdminClient.java
index 1088b85ae27..f4eaa979ff1 100644
--- a/server/src/main/java/org/opensearch/client/ClusterAdminClient.java
+++ b/server/src/main/java/org/opensearch/client/ClusterAdminClient.java
@@ -139,6 +139,8 @@ import org.opensearch.tasks.TaskId;
* Administrative actions/operations against indices.
*
* @see AdminClient#cluster()
+ *
+ * @opensearch.internal
*/
public interface ClusterAdminClient extends OpenSearchClient {
diff --git a/server/src/main/java/org/opensearch/client/FilterClient.java b/server/src/main/java/org/opensearch/client/FilterClient.java
index 4d7bf2ed30b..d121fdd77df 100644
--- a/server/src/main/java/org/opensearch/client/FilterClient.java
+++ b/server/src/main/java/org/opensearch/client/FilterClient.java
@@ -43,6 +43,8 @@ import org.opensearch.threadpool.ThreadPool;
* A {@link Client} that contains another {@link Client} which it
* uses as its basic source, possibly transforming the requests / responses along the
* way or providing additional functionality.
+ *
+ * @opensearch.internal
*/
public abstract class FilterClient extends AbstractClient {
diff --git a/server/src/main/java/org/opensearch/client/IndicesAdminClient.java b/server/src/main/java/org/opensearch/client/IndicesAdminClient.java
index 50430e3eb85..c9cd0d0900b 100644
--- a/server/src/main/java/org/opensearch/client/IndicesAdminClient.java
+++ b/server/src/main/java/org/opensearch/client/IndicesAdminClient.java
@@ -132,6 +132,8 @@ import org.opensearch.common.Nullable;
* Administrative actions/operations against indices.
*
* @see AdminClient#indices()
+ *
+ * @opensearch.internal
*/
public interface IndicesAdminClient extends OpenSearchClient {
diff --git a/server/src/main/java/org/opensearch/client/OpenSearchClient.java b/server/src/main/java/org/opensearch/client/OpenSearchClient.java
index 9b092c98aa5..755aca1f573 100644
--- a/server/src/main/java/org/opensearch/client/OpenSearchClient.java
+++ b/server/src/main/java/org/opensearch/client/OpenSearchClient.java
@@ -39,6 +39,11 @@ import org.opensearch.action.ActionRequest;
import org.opensearch.action.ActionResponse;
import org.opensearch.threadpool.ThreadPool;
+/**
+ * Interface for an OpenSearch client implementation
+ *
+ * @opensearch.internal
+ */
public interface OpenSearchClient {
/**
diff --git a/server/src/main/java/org/opensearch/client/OriginSettingClient.java b/server/src/main/java/org/opensearch/client/OriginSettingClient.java
index acb6352b061..41fe9741cc4 100644
--- a/server/src/main/java/org/opensearch/client/OriginSettingClient.java
+++ b/server/src/main/java/org/opensearch/client/OriginSettingClient.java
@@ -46,6 +46,8 @@ import java.util.function.Supplier;
* {@link ThreadContext#stashWithOrigin origin} set to a particular
* value and calls its {@linkplain ActionListener} in its original
* {@link ThreadContext}.
+ *
+ * @opensearch.internal
*/
public final class OriginSettingClient extends FilterClient {
diff --git a/server/src/main/java/org/opensearch/client/ParentTaskAssigningClient.java b/server/src/main/java/org/opensearch/client/ParentTaskAssigningClient.java
index 444f0ea778b..58ea99fa96b 100644
--- a/server/src/main/java/org/opensearch/client/ParentTaskAssigningClient.java
+++ b/server/src/main/java/org/opensearch/client/ParentTaskAssigningClient.java
@@ -43,6 +43,8 @@ import org.opensearch.tasks.TaskId;
/**
* A {@linkplain Client} that sets the parent task on all requests that it makes. Use this to conveniently implement actions that cause
* many other actions.
+ *
+ * @opensearch.internal
*/
public class ParentTaskAssigningClient extends FilterClient {
private final TaskId parentTask;
diff --git a/server/src/main/java/org/opensearch/client/Requests.java b/server/src/main/java/org/opensearch/client/Requests.java
index d89f55a37a9..b04de7830a7 100644
--- a/server/src/main/java/org/opensearch/client/Requests.java
+++ b/server/src/main/java/org/opensearch/client/Requests.java
@@ -79,6 +79,8 @@ import org.opensearch.common.xcontent.XContentType;
/**
* A handy one stop shop for creating requests (make sure to import static this class).
+ *
+ * @opensearch.internal
*/
public class Requests {
diff --git a/server/src/main/java/org/opensearch/client/node/NodeClient.java b/server/src/main/java/org/opensearch/client/node/NodeClient.java
index bda7cdca910..56cb7c40674 100644
--- a/server/src/main/java/org/opensearch/client/node/NodeClient.java
+++ b/server/src/main/java/org/opensearch/client/node/NodeClient.java
@@ -52,6 +52,8 @@ import java.util.function.Supplier;
/**
* Client that executes actions on the local node.
+ *
+ * @opensearch.internal
*/
public class NodeClient extends AbstractClient {
diff --git a/server/src/main/java/org/opensearch/client/support/AbstractClient.java b/server/src/main/java/org/opensearch/client/support/AbstractClient.java
index 4c8f5935e36..4fdf4b1166b 100644
--- a/server/src/main/java/org/opensearch/client/support/AbstractClient.java
+++ b/server/src/main/java/org/opensearch/client/support/AbstractClient.java
@@ -366,6 +366,11 @@ import org.opensearch.threadpool.ThreadPool;
import java.util.Map;
+/**
+ * Base client used to create concrete client implementations
+ *
+ * @opensearch.internal
+ */
public abstract class AbstractClient implements Client {
protected final Logger logger;
diff --git a/server/src/main/java/org/opensearch/client/transport/NoNodeAvailableException.java b/server/src/main/java/org/opensearch/client/transport/NoNodeAvailableException.java
index a4ffe210203..e3424689c51 100644
--- a/server/src/main/java/org/opensearch/client/transport/NoNodeAvailableException.java
+++ b/server/src/main/java/org/opensearch/client/transport/NoNodeAvailableException.java
@@ -40,6 +40,8 @@ import java.io.IOException;
/**
* An exception indicating no node is available to perform the operation.
+ *
+ * @opensearch.internal
*/
public class NoNodeAvailableException extends OpenSearchException {