Fix: Changes requested with file name

fossology · May 15, 2024 · ed157f5 · ed157f5
1 parent 1f1d641
commit ed157f5
Show file tree

Hide file tree

Showing 4 changed files with 196 additions and 157 deletions.
diff --git a/cmd/laas/docs/docs.go b/cmd/laas/docs/docs.go
@@ -447,7 +447,7 @@ const docTemplate = `{
                         "schema": {
                             "type": "array",
                             "items": {
-                                "$ref": "#/definitions/models.LicenseJson"
+                                "$ref": "#/definitions/models.ExportLicenseDB"
                             }
                         }
                     },
@@ -1456,21 +1456,7 @@ const docTemplate = `{
                 }
             }
         },
-        "models.ImportObligationsResponse": {
-            "type": "object",
-            "properties": {
-                "data": {
-                    "description": "can be of type models.LicenseError or models.ObligationImportStatus",
-                    "type": "array",
-                    "items": {}
-                },
-                "status": {
-                    "type": "integer",
-                    "example": 200
-                }
-            }
-        },
-        "models.LicenseDB": {
+        "models.ExportLicenseDB": {
             "type": "object",
             "properties": {
                 "external_ref": {
@@ -1516,10 +1502,6 @@ const docTemplate = `{
                     "type": "string",
                     "example": "MIT License"
                 },
-                "rf_id": {
-                    "type": "integer",
-                    "example": 123
-                },
                 "rf_notes": {
                     "type": "string",
                     "example": "This license has been superseded."
@@ -1551,93 +1533,123 @@ const docTemplate = `{
                 }
             }
         },
-        "models.LicenseError": {
+        "models.ImportObligationsResponse": {
             "type": "object",
             "properties": {
-                "error": {
-                    "type": "string",
-                    "example": "invalid request body"
-                },
-                "message": {
-                    "type": "string",
-                    "example": "invalid request body"
-                },
-                "path": {
-                    "type": "string",
-                    "example": "/api/v1/licenses"
+                "data": {
+                    "description": "can be of type models.LicenseError or models.ObligationImportStatus",
+                    "type": "array",
+                    "items": {}
                 },
                 "status": {
                     "type": "integer",
-                    "example": 400
-                },
-                "timestamp": {
-                    "type": "string",
-                    "example": "2023-12-01T10:00:51+05:30"
+                    "example": 200
                 }
             }
         },
-        "models.LicenseJson": {
+        "models.LicenseDB": {
             "type": "object",
             "properties": {
+                "external_ref": {
+                    "$ref": "#/definitions/datatypes.JSONType-models_LicenseDBSchemaExtension"
+                },
                 "marydone": {
-                    "type": "string"
+                    "type": "boolean"
                 },
                 "rf_FSFfree": {
-                    "type": "string"
+                    "type": "boolean"
                 },
                 "rf_Fedora": {
                     "type": "string"
                 },
                 "rf_GPLv2compatible": {
-                    "type": "string"
+                    "type": "boolean"
                 },
                 "rf_GPLv3compatible": {
-                    "type": "string"
+                    "type": "boolean"
                 },
                 "rf_OSIapproved": {
-                    "type": "string"
+                    "type": "boolean"
                 },
                 "rf_active": {
-                    "type": "string"
+                    "type": "boolean"
                 },
                 "rf_add_date": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "2023-12-01T18:10:25.00+05:30"
                 },
                 "rf_copyleft": {
-                    "type": "string"
+                    "type": "boolean"
                 },
                 "rf_detector_type": {
-                    "type": "integer"
+                    "type": "integer",
+                    "example": 1
                 },
                 "rf_flag": {
-                    "type": "string"
+                    "type": "integer",
+                    "example": 1
                 },
                 "rf_fullname": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "MIT License"
+                },
+                "rf_id": {
+                    "type": "integer",
+                    "example": 123
                 },
                 "rf_notes": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "This license has been superseded."
                 },
                 "rf_risk": {
-                    "type": "string"
+                    "type": "integer"
                 },
                 "rf_shortname": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "MIT"
                 },
                 "rf_source": {
                     "type": "string"
                 },
-                "rf_spdx_compatible": {
-                    "type": "string"
+                "rf_spdx_id": {
+                    "type": "string",
+                    "example": "MIT"
                 },
                 "rf_text": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "MIT License Text here"
                 },
                 "rf_text_updatable": {
-                    "type": "string"
+                    "type": "boolean"
                 },
                 "rf_url": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "https://opensource.org/licenses/MIT"
+                }
+            }
+        },
+        "models.LicenseError": {
+            "type": "object",
+            "properties": {
+                "error": {
+                    "type": "string",
+                    "example": "invalid request body"
+                },
+                "message": {
+                    "type": "string",
+                    "example": "invalid request body"
+                },
+                "path": {
+                    "type": "string",
+                    "example": "/api/v1/licenses"
+                },
+                "status": {
+                    "type": "integer",
+                    "example": 400
+                },
+                "timestamp": {
+                    "type": "string",
+                    "example": "2023-12-01T10:00:51+05:30"
                 }
             }
         },