From 9fde4b0e0cc8584c6044c71bf8da12ad4c6dff33 Mon Sep 17 00:00:00 2001
From: Finn Carroll <carrofin@amazon.com>
Date: Fri, 23 Aug 2024 03:57:24 +0000
Subject: [PATCH] Javadocs

Signed-off-by: Finn Carroll <carrofin@amazon.com>
---
 .../search/fetch/serde/FetchSearchResultsSerDe.java    |  1 +
 .../opensearch/search/fetch/serde/SearchHitSerDe.java  |  1 +
 .../opensearch/search/fetch/serde/SearchHitsSerDe.java |  1 +
 .../java/org/opensearch/search/fetch/serde/SerDe.java  |  5 +++++
 .../opensearch/search/fetch/serde/package-info.java    | 10 ++++++++++
 5 files changed, 18 insertions(+)
 create mode 100644 server/src/main/java/org/opensearch/search/fetch/serde/package-info.java

diff --git a/server/src/main/java/org/opensearch/search/fetch/serde/FetchSearchResultsSerDe.java b/server/src/main/java/org/opensearch/search/fetch/serde/FetchSearchResultsSerDe.java
index b418a798112c9..5bbadae3bd1da 100644
--- a/server/src/main/java/org/opensearch/search/fetch/serde/FetchSearchResultsSerDe.java
+++ b/server/src/main/java/org/opensearch/search/fetch/serde/FetchSearchResultsSerDe.java
@@ -18,6 +18,7 @@
 
 /**
  * Serialization/Deserialization implementations for SearchHit.
+ * @opensearch.internal
  */
 public class FetchSearchResultsSerDe implements SerDe.StreamSerializer<FetchSearchResult>, SerDe.StreamDeserializer<FetchSearchResult> {
     /**
diff --git a/server/src/main/java/org/opensearch/search/fetch/serde/SearchHitSerDe.java b/server/src/main/java/org/opensearch/search/fetch/serde/SearchHitSerDe.java
index 667ad2551f94f..9ee0a3eb87964 100644
--- a/server/src/main/java/org/opensearch/search/fetch/serde/SearchHitSerDe.java
+++ b/server/src/main/java/org/opensearch/search/fetch/serde/SearchHitSerDe.java
@@ -36,6 +36,7 @@
 
 /**
  * Serialization/Deserialization implementations for SearchHit.
+ * @opensearch.internal
  */
 public class SearchHitSerDe implements SerDe.StreamSerializer<SearchHit>, SerDe.StreamDeserializer<SearchHit> {
 
diff --git a/server/src/main/java/org/opensearch/search/fetch/serde/SearchHitsSerDe.java b/server/src/main/java/org/opensearch/search/fetch/serde/SearchHitsSerDe.java
index 7a549bf79f109..199bcc2ee564b 100644
--- a/server/src/main/java/org/opensearch/search/fetch/serde/SearchHitsSerDe.java
+++ b/server/src/main/java/org/opensearch/search/fetch/serde/SearchHitsSerDe.java
@@ -22,6 +22,7 @@
 
 /**
  * Serialization/Deserialization implementations for SearchHits.
+ * @opensearch.internal
  */
 public class SearchHitsSerDe implements SerDe.StreamSerializer<SearchHits>, SerDe.StreamDeserializer<SearchHits> {
     SearchHitSerDe searchHitSerDe;
diff --git a/server/src/main/java/org/opensearch/search/fetch/serde/SerDe.java b/server/src/main/java/org/opensearch/search/fetch/serde/SerDe.java
index 9f5292fa6e563..8f36e0a2a8c4a 100644
--- a/server/src/main/java/org/opensearch/search/fetch/serde/SerDe.java
+++ b/server/src/main/java/org/opensearch/search/fetch/serde/SerDe.java
@@ -15,9 +15,14 @@
 
 /**
  * Base class for supported serialization/deserialization implementations.
+ * @opensearch.internal
  */
 public class SerDe {
 
+    /**
+     * Serialization/Deserialization exception.
+     * @opensearch.internal
+     */
     public static class SerializationException extends RuntimeException {
         public SerializationException(String message) {
             super(message);
diff --git a/server/src/main/java/org/opensearch/search/fetch/serde/package-info.java b/server/src/main/java/org/opensearch/search/fetch/serde/package-info.java
new file mode 100644
index 0000000000000..701546ae6289d
--- /dev/null
+++ b/server/src/main/java/org/opensearch/search/fetch/serde/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.
+ */
+
+/** Serialization/Deserialization implementations for the fetch package. */
+package org.opensearch.search.fetch.serde;