feat(schema): rename base to core (#176)

aica-technology · Sep 20, 2024 · d90a719 · d90a719
1 parent ab5c1c7
commit d90a719
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 17 deletions.
diff --git a/docs/static/schemas/draft/2-0-0/application.d.ts b/docs/static/schemas/draft/2-0-0/application.d.ts
@@ -10,9 +10,9 @@
  */
 export type Schema = string;
 /**
- * The version of the AICA base image
+ * The version of the AICA Core image
  */
-export type BaseVersion = string;
+export type CoreVersion = string;
 /**
  * The name of the package
  */
@@ -398,10 +398,10 @@ export interface YAMLApplicationDescription {
 }
 
 /**
- * The application dependencies, including the base version and any required packages
+ * The application dependencies, including the version of AICA Core and any required packages
  */
 export interface Dependencies {
-    base: BaseVersion;
+    core: CoreVersion;
     packages?: ApplicationPackages;
 }
 

diff --git a/docs/static/schemas/draft/2-0-0/application.schema.json b/docs/static/schemas/draft/2-0-0/application.schema.json
@@ -19,13 +19,13 @@
     },
     "dependencies": {
       "title": "Dependencies",
-      "description": "The application dependencies, including the base version and any required packages",
+      "description": "The application dependencies, including the version of AICA Core and any required packages",
       "type": "object",
       "additionalProperties": false,
       "properties": {
-        "base": {
-          "title": "Base Version",
-          "description": "The version of the AICA base image",
+        "core": {
+          "title": "Core Version",
+          "description": "The version of the AICA Core image",
           "examples": [
             "v3.1.1",
             "v4.0.0"
@@ -88,7 +88,7 @@
         }
       },
       "required": [
-        "base"
+        "core"
       ]
     },
     "metadata": {

diff --git a/schemas/applications/CHANGELOG.md b/schemas/applications/CHANGELOG.md
@@ -17,7 +17,7 @@ Release Versions:
 
 ### New features in 2-0-0
 
-- Application dependencies can be defined under the top-level `dependencies` property, including the base image version
+- Application dependencies can be defined under the top-level `dependencies` property, including the core image version
   and additional packages
 - Application metadata can be defined under the top-level `metadata` property including a name, description and tags
 - Any additional user data can be included in an application under the top-level `userdata` property

diff --git a/schemas/applications/README.md b/schemas/applications/README.md
@@ -26,14 +26,14 @@ names in the application must be `lower_snake_case`.
 
 The new schema requires two new top-level properties to be defined in all applications. These are `schema`, which must
 declare the syntax version of the current application, and `dependencies`, which must at minimum define the version of
-the base AICA image required to run the application. Refer to the complete documentation for additional information
+the AICA Core image required to run the application. Refer to the complete documentation for additional information
 on these new properties.
 
 ```yaml
 schema: 2-0-0
 
 dependencies:
-  base: v4.0.0
+  core: v4.0.0
 ```
 
 #### Graph positions

diff --git a/schemas/applications/schema/application.schema.json b/schemas/applications/schema/application.schema.json
@@ -19,13 +19,13 @@
     },
     "dependencies": {
       "title": "Dependencies",
-      "description": "The application dependencies, including the base version and any required packages",
+      "description": "The application dependencies, including the version of AICA Core and any required packages",
       "type": "object",
       "additionalProperties": false,
       "properties": {
-        "base": {
-          "title": "Base Version",
-          "description": "The version of the AICA base image",
+        "core": {
+          "title": "Core Version",
+          "description": "The version of the AICA Core image",
           "examples": [
             "v3.1.1",
             "v4.0.0"
@@ -88,7 +88,7 @@
         }
       },
       "required": [
-        "base"
+        "core"
       ]
     },
     "metadata": {