Implement Rest api to update role permissions on asset [#33918]

dotCMS/src/main/java/com/dotcms/rest/api/v1/system/permission/AbstractRolePermissionAssetView.java

@@ -0,0 +1,131 @@
+package com.dotcms.rest.api.v1.system.permission;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import io.swagger.v3.oas.annotations.media.Schema;
+import org.immutables.value.Value;
+
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Represents a permission asset (host or folder) with role permissions.
+ * Contains asset metadata and permission levels for a specific role.
+ *
+ * @author hassandotcms
+ */
+@Value.Style(typeImmutable = "*", typeAbstract = "Abstract*")
+@Value.Immutable
+@JsonSerialize(as = RolePermissionAssetView.class)
+@JsonDeserialize(as = RolePermissionAssetView.class)
+@Schema(description = "Permission asset with role permission assignments")
+public interface AbstractRolePermissionAssetView {
+
+    /**
+     * Gets the asset identifier.
+     *
+     * @return Asset ID (host identifier for HOST type, folder inode for FOLDER type)
+     */
+    @JsonProperty("id")
+    @Schema(
+        description = "Asset identifier (host identifier for HOST type, folder inode for FOLDER type)",
+        example = "abc-123-def-456",
+        requiredMode = Schema.RequiredMode.REQUIRED
+    )
+    String id();
+
+    /**
+     * Gets the asset type.
+     *
+     * @return Asset type (HOST or FOLDER)
+     */
+    @JsonProperty("type")
+    @Schema(
+        description = "Asset type",
+        allowableValues = {"HOST", "FOLDER"},
+        example = "HOST",
+        requiredMode = Schema.RequiredMode.REQUIRED
+    )
+    String type();
+
+    /**
+     * Gets the asset name.
+     *
+     * @return Asset name (hostname for HOST, folder name for FOLDER)
+     */
+    @JsonProperty("name")
+    @Schema(
+        description = "Asset name (hostname for HOST, folder name for FOLDER)",
+        example = "demo.dotcms.com",
+        requiredMode = Schema.RequiredMode.REQUIRED
+    )
+    String name();
+
+    /**
+     * Gets the full path to the asset.
+     *
+     * @return Asset path
+     */
+    @JsonProperty("path")
+    @Schema(
+        description = "Full path to the asset",
+        example = "/demo.dotcms.com/application",
+        requiredMode = Schema.RequiredMode.REQUIRED
+    )
+    String path();
+
+    /**
+     * Gets the host identifier.
+     *
+     * @return Host ID (same as id for HOST type, parent host for FOLDER type)
+     */
+    @JsonProperty("hostId")
+    @Schema(
+        description = "Host identifier (same as id for HOST type, parent host for FOLDER type)",
+        example = "abc-123-def-456",
+        requiredMode = Schema.RequiredMode.REQUIRED
+    )
+    String hostId();
+
+    /**
+     * Checks if the user can edit permissions on this asset.
+     *
+     * @return true if user can edit permissions, false otherwise
+     */
+    @JsonProperty("canEditPermissions")
+    @Schema(
+        description = "Whether the requesting user can edit permissions on this asset",
+        example = "true",
+        requiredMode = Schema.RequiredMode.REQUIRED
+    )
+    boolean canEditPermissions();
+
+    /**
+     * Checks if this asset inherits permissions from its parent.
+     *
+     * @return true if permissions are inherited, false otherwise
+     */
+    @JsonProperty("inheritsPermissions")
+    @Schema(
+        description = "Whether this asset inherits permissions from its parent",
+        example = "false",
+        requiredMode = Schema.RequiredMode.REQUIRED
+    )
+    boolean inheritsPermissions();
+
+    /**
+     * Gets the permission assignments for this asset and role.
+     * Map keys are permission scopes (INDIVIDUAL, CONTENT, FOLDER, HOST, etc.)
+     * and values are lists of permission level names (READ, WRITE, etc.).
+     *
+     * @return Permission map
+     */
+    @JsonProperty("permissions")
+    @Schema(
+        description = "Map of permission scopes (INDIVIDUAL, CONTENT, FOLDER, HOST, etc.) to lists of permission level names (READ, WRITE, PUBLISH, EDIT_PERMISSIONS, CAN_ADD_CHILDREN)",
+        example = "{\"INDIVIDUAL\": [\"READ\", \"WRITE\", \"PUBLISH\"], \"CONTENT\": [\"READ\"]}",
+        requiredMode = Schema.RequiredMode.REQUIRED
+    )
+    Map<String, List<String>> permissions();
+}

dotCMS/src/main/java/com/dotcms/rest/api/v1/system/permission/AbstractRolePermissionsView.java

@@ -0,0 +1,63 @@
+package com.dotcms.rest.api.v1.system.permission;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import io.swagger.v3.oas.annotations.media.Schema;
+import org.immutables.value.Value;
+
+import java.util.List;
+
+/**
+ * Response wrapper containing a role's permission assignments organized by assets.
+ * Includes role information and a list of permission assets (hosts and folders)
+ * where the role has access.
+ *
+ * @author dotCMS
+ * @since 24.01
+ */
+@Value.Style(typeImmutable = "*", typeAbstract = "Abstract*")
+@Value.Immutable
+@JsonSerialize(as = RolePermissionsView.class)
+@JsonDeserialize(as = RolePermissionsView.class)
+@Schema(description = "Role permissions organized by assets")
+public interface AbstractRolePermissionsView {
+
+    /**
+     * Gets the role identifier.
+     *
+     * @return Role identifier
+     */
+    @JsonProperty("roleId")
+    @Schema(
+        description = "Role identifier",
+        example = "abc-123-def-456",
+        requiredMode = Schema.RequiredMode.REQUIRED
+    )
+    String roleId();
+
+    /**
+     * Gets the role display name.
+     *
+     * @return Role name
+     */
+    @JsonProperty("roleName")
+    @Schema(
+        description = "Role display name",
+        example = "CMS Administrator",
+        requiredMode = Schema.RequiredMode.REQUIRED
+    )
+    String roleName();
+
+    /**
+     * Gets the list of permission assets.
+     *
+     * @return List of permission assets (hosts and folders)
+     */
+    @JsonProperty("assets")
+    @Schema(
+        description = "List of permission assets (hosts and folders) with their permission assignments",
+        requiredMode = Schema.RequiredMode.REQUIRED
+    )
+    List<UserPermissionAssetView> assets();
+}

dotCMS/src/main/java/com/dotcms/rest/api/v1/system/permission/AbstractUpdateRolePermissionsView.java

@@ -0,0 +1,59 @@
+package com.dotcms.rest.api.v1.system.permission;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import io.swagger.v3.oas.annotations.media.Schema;
+import org.immutables.value.Value;
+
+/**
+ * View for update role permissions operation result.
+ * Contains the result of updating permissions for a role on an asset.
+ *
+ * @author hassandotcms
+ */
+@Value.Style(typeImmutable = "*", typeAbstract = "Abstract*")
+@Value.Immutable
+@JsonSerialize(as = UpdateRolePermissionsView.class)
+@JsonDeserialize(as = UpdateRolePermissionsView.class)
+@Schema(description = "Result of updating role permissions on an asset")
+public interface AbstractUpdateRolePermissionsView {
+
+    /**
+     * Gets the role identifier.
+     *
+     * @return Role ID
+     */
+    @JsonProperty("roleId")
+    @Schema(
+        description = "Role identifier",
+        example = "abc-123-def-456",
+        requiredMode = Schema.RequiredMode.REQUIRED
+    )
+    String roleId();
+
+    /**
+     * Gets the role name.
+     *
+     * @return Role name
+     */
+    @JsonProperty("roleName")
+    @Schema(
+        description = "Role name",
+        example = "Content Editor",
+        requiredMode = Schema.RequiredMode.REQUIRED
+    )
+    String roleName();
+
+    /**
+     * Gets the updated asset with permissions.
+     *
+     * @return Role permission asset view
+     */
+    @JsonProperty("asset")
+    @Schema(
+        description = "The updated asset with new permission assignments for this role",
+        requiredMode = Schema.RequiredMode.REQUIRED
+    )
+    RolePermissionAssetView asset();
+}