[Javadoc] Add missing package-info.java files to server (#3128)

In preparation for re-enabling the missingJavadoc gradle task this change adds
in the missing package-info.java files to the server folder. For now general
javadocs are added to these files with the intent to clean up with better
descriptions over time.

Signed-off-by: Nicholas Walter Knize <[email protected]>

gradle/missing-javadoc.gradle

@@ -162,7 +162,6 @@ configure([
   project(":qa:os"),
   project(":qa:wildfly"),
   project(":rest-api-spec"),
-  project(":server"),
   project(":test:external-modules:test-delayed-aggs"),
   project(":test:fixtures:azure-fixture"),
   project(":test:fixtures:gcs-fixture"),
@@ -177,6 +176,14 @@ configure([
   }
 }
 
+configure(project(":server")) {
+  project.tasks.withType(MissingJavadocTask) {
+    isExcluded = true
+    // TODO: reenable after fixing missing javadocs
+    // javadocMissingLevel = "class"
+  }
+}
+
 class MissingJavadocTask extends DefaultTask {
   @InputFiles
   @SkipWhenEmpty
@@ -274,6 +281,10 @@ class MissingJavadocTask extends DefaultTask {
     if (!classpath.isEmpty()) {
       opts << [ '-classpath', classpath.asPath ]
     }
+
+    opts << [ '-tag', 'opensearch.experimental:a:WARNING: This API is experimental and might change in incompatible ways in the next release.' ]
+    opts << [ '-tag', 'opensearch.internal:a:NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.' ]
+
     opts << [ '-doclet', "org.opensearch.missingdoclet.MissingDoclet" ]
     opts << [ '-docletpath', docletpath.asPath ]
     opts << [ '--missing-level', javadocMissingLevel ]

server/src/main/java/org/opensearch/action/admin/cluster/allocation/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Cluster allocation transport handlers. */
+package org.opensearch.action.admin.cluster.allocation;

server/src/main/java/org/opensearch/action/admin/cluster/configuration/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Cluster configuration transport handlers. */
+package org.opensearch.action.admin.cluster.configuration;

server/src/main/java/org/opensearch/action/admin/cluster/health/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Cluster Health transport handlers. */
+package org.opensearch.action.admin.cluster.health;

server/src/main/java/org/opensearch/action/admin/cluster/node/hotthreads/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Hot threads at node level transport handlers. */
+package org.opensearch.action.admin.cluster.node.hotthreads;

server/src/main/java/org/opensearch/action/admin/cluster/node/info/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Node Info transport handlers. */
+package org.opensearch.action.admin.cluster.node.info;

server/src/main/java/org/opensearch/action/admin/cluster/node/liveness/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Node liveness transport handlers. */
+package org.opensearch.action.admin.cluster.node.liveness;

server/src/main/java/org/opensearch/action/admin/cluster/node/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Node level transport handlers. */
+package org.opensearch.action.admin.cluster.node;

server/src/main/java/org/opensearch/action/admin/cluster/node/reload/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Node reloading secured settings transport handlers. */
+package org.opensearch.action.admin.cluster.node.reload;

server/src/main/java/org/opensearch/action/admin/cluster/node/stats/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Node Stats transport handlers. */
+package org.opensearch.action.admin.cluster.node.stats;

server/src/main/java/org/opensearch/action/admin/cluster/node/tasks/cancel/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Transport handler for Cancelling Node Tasks */
+package org.opensearch.action.admin.cluster.node.tasks.cancel;

server/src/main/java/org/opensearch/action/admin/cluster/node/tasks/get/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Transport handlers for getting Node Tasks. */
+package org.opensearch.action.admin.cluster.node.tasks.get;

server/src/main/java/org/opensearch/action/admin/cluster/node/tasks/list/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Transport handlers for listing node tasks. */
+package org.opensearch.action.admin.cluster.node.tasks.list;

server/src/main/java/org/opensearch/action/admin/cluster/node/tasks/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Node tasks transport handlers. */
+package org.opensearch.action.admin.cluster.node.tasks;

server/src/main/java/org/opensearch/action/admin/cluster/node/usage/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Node Usage transport handlers. */
+package org.opensearch.action.admin.cluster.node.usage;

server/src/main/java/org/opensearch/action/admin/cluster/remote/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Remote Node Information transport handlers. */
+package org.opensearch.action.admin.cluster.remote;

server/src/main/java/org/opensearch/action/admin/cluster/repositories/cleanup/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Transport handler for cleaning up a snapshot repository. */
+package org.opensearch.action.admin.cluster.repositories.cleanup;

server/src/main/java/org/opensearch/action/admin/cluster/repositories/delete/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Transport handler for deleting a snapshot repository. */
+package org.opensearch.action.admin.cluster.repositories.delete;

server/src/main/java/org/opensearch/action/admin/cluster/repositories/get/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Transport handler for getting a snapshot repository. */
+package org.opensearch.action.admin.cluster.repositories.get;

server/src/main/java/org/opensearch/action/admin/cluster/repositories/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Repository transport handlers. */
+package org.opensearch.action.admin.cluster.repositories;

server/src/main/java/org/opensearch/action/admin/cluster/repositories/put/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Transport handlers for putting a new snapshot repository */
+package org.opensearch.action.admin.cluster.repositories.put;

server/src/main/java/org/opensearch/action/admin/cluster/repositories/verify/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Transport handler for verifying a snapshot repository. */
+package org.opensearch.action.admin.cluster.repositories.verify;

server/src/main/java/org/opensearch/action/admin/cluster/reroute/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Cluster reroute transport handlers. */
+package org.opensearch.action.admin.cluster.reroute;

server/src/main/java/org/opensearch/action/admin/cluster/settings/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Cluster settings transport handlers. */
+package org.opensearch.action.admin.cluster.settings;

server/src/main/java/org/opensearch/action/admin/cluster/shards/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Search Shards transport handlers. */
+package org.opensearch.action.admin.cluster.shards;

server/src/main/java/org/opensearch/action/admin/cluster/snapshots/clone/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Clone Snapshot transport handler. */
+package org.opensearch.action.admin.cluster.snapshots.clone;

server/src/main/java/org/opensearch/action/admin/cluster/snapshots/create/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Create Snapshot transport handler. */
+package org.opensearch.action.admin.cluster.snapshots.create;

server/src/main/java/org/opensearch/action/admin/cluster/snapshots/delete/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Delete Snapshot transport handler. */
+package org.opensearch.action.admin.cluster.snapshots.delete;

server/src/main/java/org/opensearch/action/admin/cluster/snapshots/get/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Get Snapshot transport handler. */
+package org.opensearch.action.admin.cluster.snapshots.get;

server/src/main/java/org/opensearch/action/admin/cluster/snapshots/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Snapshot transport handlers. */
+package org.opensearch.action.admin.cluster.snapshots;

server/src/main/java/org/opensearch/action/admin/cluster/snapshots/restore/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Restore Snapshot transport handler. */
+package org.opensearch.action.admin.cluster.snapshots.restore;

server/src/main/java/org/opensearch/action/admin/cluster/snapshots/status/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Snapshot Status transport handlers. */
+package org.opensearch.action.admin.cluster.snapshots.status;

server/src/main/java/org/opensearch/action/admin/cluster/state/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Cluster State transport handler. */
+package org.opensearch.action.admin.cluster.state;

server/src/main/java/org/opensearch/action/admin/cluster/stats/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Cluster Stats transport handlers. */
+package org.opensearch.action.admin.cluster.stats;