fix(config-api): added asset validation and pagination, removed redundant fields for TR, agama swagger spec

jans-config-api/common/src/main/java/io/jans/configapi/model/configuration/AssetMgtConfiguration.java

@@ -16,25 +16,39 @@ public class AssetMgtConfiguration {
      */
     private boolean assetServerUploadEnabled;
 
+    /**
+     * Flag indicating if file extension validation is enabled
+     */
+    private boolean fileExtensionValidationEnabled;
+
+    /**
+     * Flag indicating if service module name extension validation is enabled
+     */
+    private boolean moduleNameValidationEnabled;
+
     /**
      * Base directory on server to upload the asset
      */
     private String assetBaseDirectory;
 
+    /**
+     * List of supported service module where asset can be uploaded
+     */
+    private List<String> jansModules;
+
     /**
      * Asset type mapped to server directory
      */
     private List<AssetDirMapping> assetDirMapping;
-
-
+
     public boolean isAssetMgtEnabled() {
         return assetMgtEnabled;
     }
 
     public void setAssetMgtEnabled(boolean assetMgtEnabled) {
         this.assetMgtEnabled = assetMgtEnabled;
     }
-    
+
     public boolean isAssetServerUploadEnabled() {
         return assetServerUploadEnabled;
     }
@@ -43,6 +57,22 @@ public void setAssetServerUploadEnabled(boolean assetServerUploadEnabled) {
         this.assetServerUploadEnabled = assetServerUploadEnabled;
     }
 
+    public boolean isFileExtensionValidationEnabled() {
+        return fileExtensionValidationEnabled;
+    }
+
+    public void setFileExtensionValidationEnabled(boolean fileExtensionValidationEnabled) {
+        this.fileExtensionValidationEnabled = fileExtensionValidationEnabled;
+    }
+
+    public boolean isModuleNameValidationEnabled() {
+        return moduleNameValidationEnabled;
+    }
+
+    public void setModuleNameValidationEnabled(boolean moduleNameValidationEnabled) {
+        this.moduleNameValidationEnabled = moduleNameValidationEnabled;
+    }
+
     public String getAssetBaseDirectory() {
         return assetBaseDirectory;
     }
@@ -51,6 +81,14 @@ public void setAssetBaseDirectory(String assetBaseDirectory) {
         this.assetBaseDirectory = assetBaseDirectory;
     }
 
+    public List<String> getJansModules() {
+        return jansModules;
+    }
+
+    public void setJansModules(List<String> jansModules) {
+        this.jansModules = jansModules;
+    }
+
     public List<AssetDirMapping> getAssetDirMapping() {
         return assetDirMapping;
     }
@@ -62,8 +100,9 @@ public void setAssetDirMapping(List<AssetDirMapping> assetDirMapping) {
     @Override
     public String toString() {
         return "AssetMgtConfiguration [assetMgtEnabled=" + assetMgtEnabled + ", assetServerUploadEnabled="
-                + assetServerUploadEnabled + ", assetBaseDirectory=" + assetBaseDirectory + ", assetDirMapping="
-                + assetDirMapping + "]";
+                + assetServerUploadEnabled + ", fileExtensionValidationEnabled=" + fileExtensionValidationEnabled
+                + ", moduleNameValidationEnabled=" + moduleNameValidationEnabled + ", assetBaseDirectory="
+                + assetBaseDirectory + ", jansModules=" + jansModules + ", assetDirMapping=" + assetDirMapping + "]";
     }
 
 }

jans-config-api/docs/jans-config-api-swagger.yaml

@@ -250,9 +250,11 @@ paths:
           type: string
       - name: autoconfigure
         in: query
+        description: 'Boolean value to indicating to auto configure the project '
         schema:
           type: string
       requestBody:
+        description: Agama gama file
         content:
           application/zip:
             schema:
@@ -355,6 +357,8 @@ paths:
         schema:
           type: string
       requestBody:
+        description: "Agama flow config, key is `name` of config property and `value`\
+          \ is the property value. "
         content:
           application/json:
             schema:
@@ -395,11 +399,13 @@ paths:
       parameters:
       - name: start
         in: query
+        description: Start index for the result
         schema:
           type: integer
           format: int32
       - name: count
         in: query
+        description: Search size - count of the results to return
         schema:
           type: integer
           format: int32
@@ -574,7 +580,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/PagedResult'
+                $ref: '#/components/schemas/DocumentPagedResult'
               examples:
                 Response example:
                   description: Response example
@@ -659,7 +665,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/PagedResult'
+                $ref: '#/components/schemas/DocumentPagedResult'
               examples:
                 Response example:
                   description: Response example
@@ -8063,17 +8069,6 @@ components:
           type: string
         description:
           type: string
-    AssetForm:
-      required:
-      - assetFile
-      - document
-      type: object
-      properties:
-        document:
-          $ref: '#/components/schemas/Document'
-        assetFile:
-          type: string
-          format: binary
     Document:
       type: object
       properties:
@@ -8106,6 +8101,33 @@ components:
           type: string
         baseDn:
           type: string
+    DocumentPagedResult:
+      type: object
+      properties:
+        start:
+          type: integer
+          format: int32
+        totalEntriesCount:
+          type: integer
+          format: int32
+        entriesCount:
+          type: integer
+          format: int32
+        entries:
+          type: array
+          items:
+            $ref: '#/components/schemas/Document'
+    AssetForm:
+      required:
+      - assetFile
+      - document
+      type: object
+      properties:
+        document:
+          $ref: '#/components/schemas/Document'
+        assetFile:
+          type: string
+          format: binary
     AttributeValidation:
       type: object
       properties:
@@ -8219,19 +8241,19 @@ components:
           type: string
         selected:
           type: boolean
-        userCanView:
+        whitePagesCanView:
           type: boolean
-        adminCanView:
+        userCanEdit:
           type: boolean
         adminCanEdit:
           type: boolean
-        userCanEdit:
+        userCanView:
           type: boolean
-        adminCanAccess:
+        adminCanView:
           type: boolean
         userCanAccess:
           type: boolean
-        whitePagesCanView:
+        adminCanAccess:
           type: boolean
         baseDn:
           type: string
@@ -9057,8 +9079,6 @@ components:
           type: boolean
         lockMessageConfig:
           $ref: '#/components/schemas/LockMessageConfig'
-        fapi:
-          type: boolean
         allResponseTypesSupported:
           uniqueItems: true
           type: array
@@ -9068,6 +9088,8 @@ components:
             - code
             - token
             - id_token
+        fapi:
+          type: boolean
     AuthenticationFilter:
       required:
       - baseDn
@@ -9946,8 +9968,16 @@ components:
           type: boolean
         assetServerUploadEnabled:
           type: boolean
+        fileExtensionValidationEnabled:
+          type: boolean
+        moduleNameValidationEnabled:
+          type: boolean
         assetBaseDirectory:
           type: string
+        jansModules:
+          type: array
+          items:
+            type: string
         assetDirMapping:
           type: array
           items:
@@ -10109,14 +10139,14 @@ components:
           type: boolean
         internal:
           type: boolean
+        locationPath:
+          type: string
         locationType:
           type: string
           enum:
           - ldap
           - db
           - file
-        locationPath:
-          type: string
         baseDn:
           type: string
     ScriptError:
@@ -10545,10 +10575,10 @@ components:
         ttl:
           type: integer
           format: int32
-        opbrowserState:
-          type: string
         persisted:
           type: boolean
+        opbrowserState:
+          type: string
     SessionIdAccessMap:
       type: object
       properties:

jans-config-api/plugins/docs/kc-saml-plugin-swagger.yaml

@@ -1135,14 +1135,8 @@ components:
           maxLength: 4000
           minLength: 0
           type: string
-        rootUrl:
-          type: string
-        adminUrl:
-          type: string
         baseUrl:
           type: string
-        surrogateAuthRequired:
-          type: boolean
         enabled:
           type: boolean
         alwaysDisplayInConsole:
@@ -1174,9 +1168,6 @@ components:
           type: array
           items:
             type: string
-        url:
-          pattern: "^(https?|http)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
-          type: string
         spLogoutURL:
           pattern: "^$|(^(https?|http)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|])"
           type: string

jans-config-api/plugins/docs/lock-plugin-swagger.yaml

@@ -117,8 +117,6 @@ components:
           type: string
         externalLoggerConfiguration:
           type: string
-        metricChannel:
-          type: string
         metricReporterInterval:
           type: integer
           format: int32
@@ -132,15 +130,17 @@ components:
           format: int32
         opaConfiguration:
           $ref: '#/components/schemas/OpaConfiguration'
-        pdpType:
+        messageConsumerType:
+          type: string
+        policyConsumerType:
           type: string
-        policiesJsonUrisAuthorizationToken:
+        policiesJsonUrisAccessToken:
           type: string
         policiesJsonUris:
           type: array
           items:
             type: string
-        policiesZipUrisAuthorizationToken:
+        policiesZipUrisAccessToken:
           type: string
         policiesZipUris:
           type: array