renamed files and provided basic descriptions

OpenEthicsAI · Oct 27, 2024 · 616ad8c · 616ad8c
1 parent 806efcb
commit 616ad8c
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 29 deletions.
diff --git a/schema/Annotation.json → schema/oedp.annotation.schema.json b/schema/Annotation.json → schema/oedp.annotation.schema.json
@@ -1,8 +1,9 @@
 {
-  "$id": "https://openethics.ai/schemas/Annotation.json",
+  "$id": "https://openethics.ai/schemas/oedp.annotation.schema.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "title": "Annotation",
+  "title": "OEDP Dataset Annotation Schema",
   "type": "object",
+  "description": "Describes fields for the Dataset Annotation Schema in the OEDP for each single Labeler and Annotation Tool used",
   "properties": {
     "id": {
       "type": "string",
@@ -12,7 +13,7 @@
       "type": "number"
     },
     "labeler": {
-      "$ref": "./Labeler.json"
+      "$ref": "https://openethics.ai/schemas/oedp.labeler.schema.json"
     },
     "type": {
       "oneOf": [
@@ -42,7 +43,7 @@
     "tools": {
       "type": "array",
       "items": {
-        "$ref": "./Labeling-Tool.json"
+        "$ref": "https://openethics.ai/schemas/oedp.labeling_tool.schema.json"
       }
     }
   },
@@ -51,6 +52,5 @@
     "datapoints",
     "labeler",
     "type"
-  ],
-  "description": "Annotation model for each single Labeler"
+  ]
 }
diff --git a/schema/Dataset.json → schema/oedp.dataset.schema.json b/schema/Dataset.json → schema/oedp.dataset.schema.json
@@ -1,8 +1,9 @@
 {
-  "$id": "https://openethics.ai/schemas/Dataset.json",
+  "$id": "https://openethics.ai/schemas/oedp.dataset.schema.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "title": "Dataset",
+  "title": "OEDP Training Dataset Schema",
   "type": "object",
+  "description": "Describes fields for the Dataset transparency in OEDP",
   "properties": {
     "id": {
       "type": "string",
@@ -38,13 +39,12 @@
     "labeling": {
       "type": "array",
       "items": {
-        "$ref": "./Annotation.json"
+        "$ref": "https://openethics.ai/schemas/oedp.annotation.schema.json"
       }
     }
   },
   "required": [
     "id",
     "created"
-  ],
-  "description": "Dataset Model"
+  ]
 }
diff --git a/schema/Labeler.json → schema/oedp.labeler.schema.json b/schema/Labeler.json → schema/oedp.labeler.schema.json
@@ -1,8 +1,9 @@
 {
-  "$id": "https://openethics.ai/schemas/Labeler.json",
+  "$id": "https://openethics.ai/schemas/oedp.labeler.schema.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "title": "Labeler",
+  "title": "OEDP Dataset Labeler Schema",
   "type": "object",
+  "description": "Describes fields for the Dataset Labeler's profile",
   "properties": {
     "id": {
       "type": "string",
@@ -30,7 +31,7 @@
     "tools": {
       "type": "array",
       "items": {
-        "$ref": "./Labeling-Tool.json"
+        "$ref": "https://openethics.ai/schemas/oedp.labeling_tool.schema.json"
       }
     },
     "contacts": {
@@ -68,6 +69,5 @@
     "id",
     "created",
     "updated"
-  ],
-  "description": "Labeler's profile"
+  ]
 }
diff --git a/schema/Labeling-Tool.json → schema/oedp.labeling_tool.schema.json b/schema/Labeling-Tool.json → schema/oedp.labeling_tool.schema.json
@@ -1,8 +1,9 @@
 {
-  "$id": "https://openethics.ai/schemas/Labeling-Tool.json",
+  "$id": "https://openethics.ai/schemas/oedp.labeling_tool.schema.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "title": "Labeling Tool",
+  "title": "OEDP Labeling Tool Schema",
   "type": "object",
+  "description": "Schema to describe the Labeling Tool used to annotated the Dataset",
   "properties": {
     "id": {
       "type": "string",
@@ -25,6 +26,5 @@
     "id",
     "name",
     "description"
-  ],
-  "description": "Description of the Labeling Tool"
+  ]
 }
diff --git a/schema/Model.json → schema/oedp.model.schema.json b/schema/Model.json → schema/oedp.model.schema.json
@@ -1,9 +1,10 @@
 
 {
-    "$id": "https://openethics.ai/schemas/Model.json",
+    "$id": "https://openethics.ai/schemas/oedp.model.schema.json",
     "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "title": "Model",
+    "title": "OEDP AI Model Schema",
     "type": "object",
+    "description": "Describes fields required for the AI Model transparency",
     "properties": {
       "id": {
         "type": "string",
@@ -51,13 +52,12 @@
       "datasets": {
         "type": "array",
         "items": {
-          "$ref": "./Dataset.json"
+          "$ref": "https://openethics.ai/schemas/oedp.dataset.schema.json"
         }
       }
     },
     "required": [
       "id",
       "created"
-    ],
-    "description": "Model"
+    ]
   }
diff --git a/schema/Open-Ethics-Data-Passport.json → schema/oedp.passport.schema.json b/schema/Open-Ethics-Data-Passport.json → schema/oedp.passport.schema.json
@@ -1,9 +1,9 @@
 {
-  "$id": "https://openethics.ai/schemas/Open-Ethics-Data-Passport.json",
+  "$id": "https://openethics.ai/schemas/oedp.passport.schema.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "title": "Open Ethics Data Passport",
+  "title": "Open Ethics Data Passport Schema",
   "type": "object",
-  "description": "OEDP Model",
+  "description": "Describes fields in the Open Ethics Data Passport",
   "properties": {
     "id": {
       "type": "string",
@@ -12,7 +12,7 @@
     "models": {
       "type": "array",
       "items": {
-        "$ref": "./Model.json"
+        "$ref": "https://openethics.ai/schemas/oedp.model.schema.json"
       }
     },
     "scope": {