#24738 adding doc

dotCMS/src/main/java/com/dotcms/rest/api/v1/asset/AbstractFileUploadParamsJson.java

@@ -4,6 +4,9 @@
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import org.immutables.value.Value;
 
+/**
+ * File Upload Params is a json representation of a file upload request
+ */
 @Value.Style(typeImmutable="*", typeAbstract="Abstract*")
 @Value.Immutable
 @JsonDeserialize(as = FileUploadParamsJson.Builder.class)

dotCMS/src/main/java/com/dotcms/rest/api/v1/asset/AbstractFolderAndAsset.java

@@ -6,6 +6,9 @@
 import javax.annotation.Nullable;
 import org.immutables.value.Value;
 
+/**
+ * Folder And Asset is a json representation of a folder and asset
+ */
 @Value.Style(typeImmutable="*", typeAbstract="Abstract*")
 @Value.Immutable
 @JsonDeserialize(as = FolderAndAsset.Builder.class)

dotCMS/src/main/java/com/dotcms/rest/api/v1/asset/AbstractResolvedAssetAndPath.java

@@ -7,6 +7,9 @@
 import javax.annotation.Nullable;
 import org.immutables.value.Value;
 
+/**
+ * Resolved Asset And Path is a json representation of a resolved asset and path
+ */
 @Value.Style(typeImmutable="*", typeAbstract="Abstract*")
 @Value.Immutable
 @JsonDeserialize(as = ResolvedAssetAndPath.Builder.class)

dotCMS/src/main/java/com/dotcms/rest/api/v1/asset/FileUploadData.java

@@ -6,6 +6,9 @@
 import org.glassfish.jersey.media.multipart.FormDataContentDisposition;
 import org.glassfish.jersey.media.multipart.FormDataParam;
 
+/**
+ * Assets Request Form is a json representation of a request to get assets
+ */
 public class FileUploadData {
 
     @FormDataParam("file")

dotCMS/src/main/java/com/dotcms/rest/api/v1/asset/FileUploadDetail.java

@@ -4,6 +4,9 @@
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+/**
+ * File Upload Detail is a json representation of a file upload request
+ */
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class FileUploadDetail {
 

dotCMS/src/main/java/com/dotcms/rest/api/v1/asset/WebAssetHelper.java

@@ -462,6 +462,15 @@ void disposeTempFile(final DotTempFile tempFile){
         }
     }
 
+    /**
+     * checkin or publish the given contentlet
+     * @param checkout
+     * @param user
+     * @param live
+     * @return
+     * @throws DotDataException
+     * @throws DotSecurityException
+     */
     Contentlet checkinOrPublish(final Contentlet checkout, User user, final boolean live) throws DotDataException, DotSecurityException {
         if(live){
             contentletAPI.publish(checkout, user, false);

dotCMS/src/main/java/com/dotcms/rest/api/v1/asset/WebAssetResource.java

@@ -9,6 +9,7 @@
 import com.dotmarketing.exception.DotSecurityException;
 import com.dotmarketing.util.Logger;
 import com.liferay.portal.model.User;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.io.File;
 import java.io.IOException;
 import javax.servlet.http.HttpServletRequest;
@@ -32,6 +33,7 @@
  * <p> An Asset is a File or Folder </p>
  */
 @Path("/v1/assets")
+@Tag(name = "Web Assets")
 public class WebAssetResource {
 
     private final WebAssetHelper helper = WebAssetHelper.newInstance();

dotCMS/src/main/java/com/dotcms/rest/api/v1/asset/view/AbstractAssetView.java

@@ -6,6 +6,9 @@
 import java.util.Map;
 import org.immutables.value.Value;
 
+/**
+ * Asset View is a json representation of an asset
+ */
 @Value.Style(typeImmutable="*", typeAbstract="Abstract*")
 @Value.Immutable
 @JsonDeserialize(as = AssetView.Builder.class)

dotCMS/src/main/java/com/dotcms/rest/api/v1/asset/view/AbstractDeleteAssetView.java

@@ -7,6 +7,9 @@
 import javax.annotation.Nullable;
 import org.immutables.value.Value;
 
+/**
+ * Delete Asset View is a json representation of a delete asset request
+ */
 @Value.Style(typeImmutable="*", typeAbstract="Abstract*")
 @Value.Immutable
 @JsonDeserialize(as = DeleteAssetView.Builder.class)