Include the object id in schema

Signed-off-by: Keshav Priyadarshi <[email protected]>
aboutcode-org · Jul 11, 2024 · 2c08b79 · 2c08b79
1 parent bc8e854
commit 2c08b79
Show file tree

Hide file tree

Showing 3 changed files with 71 additions and 6 deletions.
diff --git a/fedcode/schemas.py b/fedcode/schemas.py
@@ -25,16 +25,15 @@ class Repository(ModelSchema):
     """
     class Meta:
         model = models.Repository
-        exclude = ["id", "admin"]
+        exclude = ["admin"]
 
 
 class Vulnerability(ModelSchema):
     repo: Repository
 
     class Meta:
         model = models.Vulnerability
-        exclude = ["id"]
-
+        fields = "__all__"
 
 class Reputation(ModelSchema):
     """
@@ -43,7 +42,7 @@ class Reputation(ModelSchema):
     """
     class Meta:
         model = models.Reputation
-        fields = ["voter", "positive"]
+        fields = ["object_id", "voter", "positive"]
 
 
 class Note(ModelSchema):
@@ -59,7 +58,7 @@ class Note(ModelSchema):
 
     class Meta:
         model = models.Note
-        exclude = ["id"]
+        fields = "__all__"
 
 
 Note.model_rebuild()
@@ -74,4 +73,4 @@ class Package(ModelSchema):
 
     class Meta:
         model = models.Package
-        exclude = ["id", "service"]
+        exclude = ["service"]
diff --git a/schemas/package.schema.json b/schemas/package.schema.json
@@ -17,6 +17,19 @@
         "reply_to": {
           "$ref": "#/$defs/Note"
         },
+        "id": {
+          "anyOf": [
+            {
+              "format": "uuid",
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "The object's unique global identifier",
+          "title": "Id"
+        },
         "acct": {
           "maxLength": 200,
           "title": "Acct",
@@ -99,6 +112,19 @@
     "Reputation": {
       "description": "https://www.w3.org/TR/activitystreams-vocabulary/#dfn-like\nhttps://www.w3.org/ns/activitystreams#Dislike",
       "properties": {
+        "object_id": {
+          "anyOf": [
+            {
+              "format": "uuid",
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "title": "Object Id"
+        },
         "voter": {
           "description": "security@vcio",
           "maxLength": 100,
@@ -145,6 +171,19 @@
       "title": "Local",
       "type": "boolean"
     },
+    "id": {
+      "anyOf": [
+        {
+          "format": "uuid",
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "The object's unique global identifier",
+      "title": "Id"
+    },
     "purl": {
       "description": "PURL (no version) ex: @pkg:maven/org.apache.logging",
       "maxLength": 300,

diff --git a/schemas/vulnerability.schema.json b/schemas/vulnerability.schema.json
@@ -7,6 +7,19 @@
     "Repository": {
       "description": "A git repository used as a backing storage for Package and vulnerability data",
       "properties": {
+        "id": {
+          "anyOf": [
+            {
+              "format": "uuid",
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "The object's unique global identifier",
+          "title": "Id"
+        },
         "url": {
           "description": "Git Repository url ex: https://github.com/nexB/vulnerablecode-data",
           "title": "Url",
@@ -72,6 +85,20 @@
     "repo": {
       "$ref": "#/$defs/Repository"
     },
+    "id": {
+      "anyOf": [
+        {
+          "maxLength": 20,
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null,
+      "description": "Unique identifier for a vulnerability in the external representation. It is prefixed with VCID-",
+      "title": "Id"
+    },
     "remote_url": {
       "anyOf": [
         {