Merge pull request #75 from siemens/license_sorting

feat(license_sorting): Enable sorting in licenses by spdx_id, fullname and shortname Reviewed-by: mishra.gaurav@siemens.com, opensource@avinal.space Tested-by: mishra.gaurav@siemens.com
fossology · Jul 24, 2024 · 27ea834 · 27ea834
2 parents 9524e7b + e4c4f0e
commit 27ea834
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 1 deletion.
diff --git a/cmd/laas/docs/docs.go b/cmd/laas/docs/docs.go
@@ -351,6 +351,29 @@ const docTemplate = `{
                         "description": "External reference parameters",
                         "name": "externalRef",
                         "in": "query"
+                    },
+                    {
+                        "enum": [
+                            "rf_spdx_id",
+                            "rf_shortname",
+                            "rf_fullname"
+                        ],
+                        "type": "string",
+                        "default": "rf_shortname",
+                        "description": "Sort by field",
+                        "name": "sort_by",
+                        "in": "query"
+                    },
+                    {
+                        "enum": [
+                            "asc",
+                            "desc"
+                        ],
+                        "type": "string",
+                        "default": "asc",
+                        "description": "Asc or desc ordering",
+                        "name": "order_by",
+                        "in": "query"
                     }
                 ],
                 "responses": {

diff --git a/cmd/laas/docs/swagger.json b/cmd/laas/docs/swagger.json
@@ -344,6 +344,29 @@
                         "description": "External reference parameters",
                         "name": "externalRef",
                         "in": "query"
+                    },
+                    {
+                        "enum": [
+                            "rf_spdx_id",
+                            "rf_shortname",
+                            "rf_fullname"
+                        ],
+                        "type": "string",
+                        "default": "rf_shortname",
+                        "description": "Sort by field",
+                        "name": "sort_by",
+                        "in": "query"
+                    },
+                    {
+                        "enum": [
+                            "asc",
+                            "desc"
+                        ],
+                        "type": "string",
+                        "default": "asc",
+                        "description": "Asc or desc ordering",
+                        "name": "order_by",
+                        "in": "query"
                     }
                 ],
                 "responses": {

diff --git a/cmd/laas/docs/swagger.yaml b/cmd/laas/docs/swagger.yaml
@@ -969,6 +969,23 @@ paths:
         in: query
         name: externalRef
         type: string
+      - default: rf_shortname
+        description: Sort by field
+        enum:
+        - rf_spdx_id
+        - rf_shortname
+        - rf_fullname
+        in: query
+        name: sort_by
+        type: string
+      - default: asc
+        description: Asc or desc ordering
+        enum:
+        - asc
+        - desc
+        in: query
+        name: order_by
+        type: string
       produces:
       - application/json
       responses:

diff --git a/pkg/api/licenses.go b/pkg/api/licenses.go
@@ -45,6 +45,8 @@ import (
 //	@Param			page			query		int						false	"Page number"
 //	@Param			limit			query		int						false	"Limit of responses per page"
 //	@Param			externalRef		query		string					false	"External reference parameters"
+//	@Param			sort_by			query		string					false	"Sort by field"			Enums(rf_spdx_id, rf_shortname, rf_fullname)	default(rf_shortname)
+//	@Param			order_by		query		string					false	"Asc or desc ordering"	Enums(asc, desc)								default(asc)
 //	@Success		200				{object}	models.LicenseResponse	"Filtered licenses"
 //	@Failure		400				{object}	models.LicenseError		"Invalid value"
 //	@Router			/licenses [get]
@@ -160,7 +162,20 @@ func FilterLicense(c *gin.Context) {
 		query = query.Where(fmt.Sprintf("external_ref->>'%s' = ?", externalRefKey), externalRefValue)
 	}
 
-	query.Order("rf_shortname")
+	sortBy := c.Query("sort_by")
+	orderBy := c.Query("order_by")
+	queryOrderString := ""
+	if sortBy != "" && (sortBy == "rf_spdx_id" || sortBy == "rf_shortname" || sortBy == "rf_fullname") {
+		queryOrderString += sortBy
+	} else {
+		queryOrderString += "rf_shortname"
+	}
+
+	if orderBy != "" && orderBy == "desc" {
+		queryOrderString += " desc"
+	}
+
+	query.Order(queryOrderString)
 
 	_ = utils.PreparePaginateResponse(c, query, &models.LicenseResponse{})