Schema generation, doc fix

mlte-team · Dec 10, 2024 · 9cfb222 · 9cfb222
1 parent bb90883
commit 9cfb222
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 20 deletions.
diff --git a/mlte/frontend/nuxt-app/assets/schema/artifact/spec/v0.0.1/schema.json b/mlte/frontend/nuxt-app/assets/schema/artifact/spec/v0.0.1/schema.json
@@ -93,13 +93,13 @@
       "title": "Artifact Type",
       "type": "string"
     },
-    "properties": {
-      "type": "array",
+    "qa_categories": {
+      "default": [],
       "items": {
         "$ref": "#/$defs/QACategoryModel"
       },
-      "default": [],
-      "title": "Properties"
+      "title": "Qa Categories",
+      "type": "array"
     }
   },
   "title": "SpecModel",

diff --git a/mlte/frontend/nuxt-app/assets/schema/artifact/validated/v0.0.1/schema.json b/mlte/frontend/nuxt-app/assets/schema/artifact/validated/v0.0.1/schema.json
@@ -167,13 +167,13 @@
           "title": "Artifact Type",
           "type": "string"
         },
-        "properties": {
-          "type": "array",
+        "qa_categories": {
+          "default": [],
           "items": {
             "$ref": "#/$defs/QACategoryModel"
           },
-          "default": [],
-          "title": "Properties"
+          "title": "Qa Categories",
+          "type": "array"
         }
       },
       "title": "SpecModel",

diff --git a/mlte/frontend/nuxt-app/assets/schema/catalog/catalog_entry/v0.0.1/schema.json b/mlte/frontend/nuxt-app/assets/schema/catalog/catalog_entry/v0.0.1/schema.json
@@ -107,7 +107,7 @@
         }
       ],
       "default": null,
-      "title": "QA Category"
+      "title": "Qa Category"
     },
     "quality_attribute": {
       "anyOf": [

diff --git a/mlte/schema/artifact/spec/v0.0.1/schema.json b/mlte/schema/artifact/spec/v0.0.1/schema.json
@@ -93,13 +93,13 @@
       "title": "Artifact Type",
       "type": "string"
     },
-    "properties": {
-      "type": "array",
+    "qa_categories": {
+      "default": [],
       "items": {
         "$ref": "#/$defs/QACategoryModel"
       },
-      "default": [],
-      "title": "Properties"
+      "title": "Qa Categories",
+      "type": "array"
     }
   },
   "title": "SpecModel",

diff --git a/mlte/schema/artifact/validated/v0.0.1/schema.json b/mlte/schema/artifact/validated/v0.0.1/schema.json
@@ -167,13 +167,13 @@
           "title": "Artifact Type",
           "type": "string"
         },
-        "properties": {
-          "type": "array",
+        "qa_categories": {
+          "default": [],
           "items": {
             "$ref": "#/$defs/QACategoryModel"
           },
-          "default": [],
-          "title": "Properties"
+          "title": "Qa Categories",
+          "type": "array"
         }
       },
       "title": "SpecModel",

diff --git a/mlte/schema/catalog/catalog_entry/v0.0.1/schema.json b/mlte/schema/catalog/catalog_entry/v0.0.1/schema.json
@@ -107,7 +107,7 @@
         }
       ],
       "default": null,
-      "title": "QA Category"
+      "title": "Qa Category"
     },
     "quality_attribute": {
       "anyOf": [
@@ -119,7 +119,7 @@
         }
       ],
       "default": null,
-      "title": "Quality attribute"
+      "title": "Quality Attribute"
     },
     "code_type": {
       "$ref": "#/$defs/CatalogEntryType"

diff --git a/mlte/spec/spec.py b/mlte/spec/spec.py
@@ -127,7 +127,7 @@ def get_qa_category(self, qa_category_id: str) -> QACategory:
         """
         Returns a particular qa category with the given id.
 
-        :param qa_category: The qa category itself, or its identifier
+        :param qa_category_id: The qa category itself, or its identifier
         :return: The qa category object.
         """
         qa_categories = [