RM-5087 - updated include params for all endpoints

rm-community/rm-community-repo/source/java/org/alfresco/rm/rest/api/impl/ApiNodesModelFactory.java

@@ -469,10 +469,6 @@ public class ApiNodesModelFactory
             {
                 transferChild.setIsClosed((Boolean) nodeService.getProperty(info.getNodeRef(), RecordsManagementModel.PROP_IS_CLOSED));
             }
-            if(isMinimalInfo && includeParam.contains(TransferChild.PARAM_IS_COMPLETED))
-            {
-                transferChild.setIsCompleted(null);
-            }
         }
         else
         {
@@ -488,10 +484,6 @@ public class ApiNodesModelFactory
             {
                 transferChild.setIsClosed(null);
             }
-            if(isMinimalInfo && includeParam.contains(TransferChild.PARAM_IS_COMPLETED))
-            {
-                transferChild.setIsCompleted(nodeService.hasAspect(info.getNodeRef(), RecordsManagementModel.ASPECT_DECLARED_RECORD));
-            }
         }
     }
 

rm-community/rm-community-repo/source/java/org/alfresco/rm/rest/api/model/TransferChild.java

@@ -39,7 +39,6 @@ public class TransferChild extends RMNode
     public static final String PARAM_IS_RECORD_FOLDER = "isRecordFolder";
     public static final String PARAM_IS_RECORD = "isRecord";
 
-    protected Boolean isCompleted;
     protected Boolean isClosed;
     protected Boolean isRecordFolder;
     protected Boolean isRecord;
@@ -48,16 +47,6 @@ public class TransferChild extends RMNode
     {
     }
 
-    public Boolean getIsCompleted()
-    {
-        return isCompleted;
-    }
-
-    public void setIsCompleted(Boolean isCompleted)
-    {
-        this.isCompleted = isCompleted;
-    }
-
     public Boolean getIsClosed()
     {
         return isClosed;

rm-community/rm-community-rest-api-explorer/src/main/webapp/definitions/gs-core-api.yaml

@@ -307,7 +307,7 @@ paths:
         - $ref: '#/parameters/filePlanIdWithAliasParam'
         - $ref: '#/parameters/skipCountParam'
         - $ref: '#/parameters/maxItemsParam'
-        - $ref: '#/parameters/recordCategoryEntryIncludeParam'
+        - $ref: '#/parameters/filePlanCategoriesEntryIncludeParam'
         - $ref: '#/parameters/filePlanIncludeSourceParam'
         - $ref: '#/parameters/fieldsParam'
       responses:
@@ -393,7 +393,7 @@ paths:
       parameters:
         - $ref: '#/parameters/filePlanIdWithAliasParam'
         - $ref: '#/parameters/autoRenameParam'
-        - $ref: '#/parameters/recordCategoryEntryIncludeParam'
+        - $ref: '#/parameters/filePlanCategoriesEntryIncludeParam'
         - $ref: '#/parameters/fieldsParam'
         - in: body
           name: nodeBodyCreate
@@ -666,7 +666,7 @@ paths:
       parameters:
         - $ref: '#/parameters/unfiledContainerIdParam'
         - $ref: '#/parameters/autoRenameParam'
-        - $ref: '#/parameters/unfiledContainerEntryIncludeParam'
+        - $ref: '#/parameters/unfiledContainerChildEntryIncludeParam'
         - $ref: '#/parameters/fieldsParam'
         - in: body
           name: nodeBodyCreate
@@ -971,7 +971,7 @@ paths:
       parameters:
         - $ref: '#/parameters/unfiledRecordFolderIdParam'
         - $ref: '#/parameters/autoRenameParam'
-        - $ref: '#/parameters/unfiledRecordFolderEntryIncludeParam'
+        - $ref: '#/parameters/unfiledRecordFolderChildEntryIncludeParam'
         - $ref: '#/parameters/fieldsParam'
         - in: body
           name: nodeBodyCreate
@@ -1565,7 +1565,7 @@ paths:
       operationId: createRecordFolderChild
       parameters:
         - $ref: '#/parameters/recordFolderIdParam'
-        - $ref: '#/parameters/recordFolderChildEntryIncludeParam'
+        - $ref: '#/parameters/recordEntryIncludeParam'
         - $ref: '#/parameters/fieldsParam'
         - in: body
           name: recordBodyCreate
@@ -1962,7 +1962,7 @@ paths:
         - $ref: '#/parameters/transferContainerIdWithAliasParam'
         - $ref: '#/parameters/skipCountParam'
         - $ref: '#/parameters/maxItemsParam'
-        - $ref: '#/parameters/transferEntryIncludeParam'
+        - $ref: '#/parameters/transferContainerChildEntryIncludeParam'
         - $ref: '#/parameters/transferContainerIncludeSourceParam'
         - $ref: '#/parameters/fieldsParam'
       responses:
@@ -2067,6 +2067,21 @@ parameters:
     items:
       type: string
     collectionFormat: csv
+  filePlanCategoriesEntryIncludeParam:
+    name: include
+    in: query
+    description: |
+      Returns additional information about the record category. Any optional field from the response model can be requested. For example:
+      * allowableOperations
+      * aspectNames
+      * hasRetentionSchedule
+      * path
+      * properties
+    required: false
+    type: array
+    items:
+      type: string
+    collectionFormat: csv
   filePlanIdWithAliasParam:
     name: filePlanId
     in: path
@@ -2093,9 +2108,7 @@ parameters:
     description: |
       Returns additional information about the unfiled records container children. Any optional field from the response model can be requested. For example:
       * allowableOperations
-      * aspectNames
       * path
-      * properties
     required: false
     type: array
     items:
@@ -2136,9 +2149,7 @@ parameters:
     description: |
       Returns additional information about the unfiled records container children. Any optional field from the response model can be requested. For example:
       * allowableOperations
-      * aspectNames
       * path
-      * properties
     required: false
     type: array
     items:
@@ -2200,10 +2211,8 @@ parameters:
     description: |
       Returns additional information about the record category. Any optional field from the response model can be requested. For example:
       * allowableOperations
-      * aspectNames
       * hasRetentionSchedule
       * path
-      * properties
     required: false
     type: array
     items:
@@ -2226,7 +2235,7 @@ parameters:
     name: include
     in: query
     description: |
-      Returns additional information about the record category. Any optional field from the response model can be requested. For example:
+      Returns additional information about the record category child. Any optional field from the response model can be requested. For example:
       * allowableOperations
       * aspectNames
       * hasRetentionSchedule
@@ -2331,6 +2340,22 @@ parameters:
     items:
       type: string
     collectionFormat: csv
+  transferContainerChildEntryIncludeParam:
+    name: include
+    in: query
+    description: |
+      Returns additional information about the transfer folders. Any optional field from the response model can be requested. For example:
+      * allowableOperations
+      * aspectNames
+      * properties
+      * transferPDFIndicator
+      * transferLocation
+      * transferAccessionIndicator
+    required: false
+    type: array
+    items:
+      type: string
+    collectionFormat: csv
   transferContainerIncludeSourceParam:
     name: includeSource
     in: query
@@ -2344,8 +2369,6 @@ parameters:
     description: |
       Returns additional information about the transfer folder. Any optional field from the response model can be requested. For example:
       * allowableOperations
-      * aspectNames
-      * properties
       * transferPDFIndicator
       * transferLocation
       * transferAccessionIndicator
@@ -2374,7 +2397,6 @@ parameters:
       * allowableOperations
       * aspectNames
       * isClosed
-      * isCompleted
       * isRecord
       * isRecordFolder
       * path
@@ -3389,10 +3411,6 @@ definitions:
         type: boolean
         default: false
         description: Indicates if the record folder is closed
-      isCompleted:
-        type: boolean
-        default: false
-        description: Present only for record nodes. Indicates if the record has a retention schedule defined
       modifiedAt:
         type: string
         format: date-time