Change env and secret for MAS

DiSSCo · Sep 18, 2024 · 8bacfe4 · 8bacfe4
1 parent ad1470d
commit 8bacfe4
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 22 deletions.
diff --git a/data-model/fdo-type/machine-annotation-service/0.3.0/schema/machine-annotation-service.json b/data-model/fdo-type/machine-annotation-service/0.3.0/schema/machine-annotation-service.json
@@ -217,17 +217,18 @@
       "description": "Object containing the tombstone metadata of the object",
       "$ref": "https://schemas.dissco.tech/schemas/fdo-type/shared-model/0.3.0/tombstone-metadata.json"
     },
-    "ods:hasEnvironment": {
+    "ods:hasEnvironmentalVariable": {
       "type": "array",
       "description": "Environmental variables to supply to the MAS, non-sensitive",
       "items": {
-        "$ref": "https://schemas.dissco.tech/schemas/fdo-type/machine-annotation-service/0.3.0/machine-annotation-service-environment.json"
+        "$ref": "https://schemas.dissco.tech/schemas/fdo-type/shared/0.3.0/environment-variable.json"
       }
     },
-    "ods:hasSecret": {
+    "ods:hasSecretVariable": {
       "type": "array",
+      "description": "Secret variables to supply to the MAS",
       "items": {
-        "$ref": "https://schemas.dissco.tech/schemas/fdo-type/machine-annotation-service/0.3.0/machine-annotation-service-secret.json"
+        "$ref": "https://schemas.dissco.tech/schemas/fdo-type/shared/0.3.0/secret-variable.json"
       }
     }
   },

diff --git a/data-model/fdo-type/shared-model/0.3.0/examples/environmental-variable-example.json b/data-model/fdo-type/shared-model/0.3.0/examples/environmental-variable-example.json
@@ -0,0 +1,4 @@
+{
+  "schema:name": "server.port",
+  "schema:value": 8080
+}
diff --git a/data-model/fdo-type/shared-model/0.3.0/examples/secret-variable.json b/data-model/fdo-type/shared-model/0.3.0/examples/secret-variable.json
@@ -0,0 +1,4 @@
+{
+  "schema:name": "database.password",
+  "ods:secretKeyRef": "db-password"
+}
diff --git a/...chine-annotation-service-environment.json → .../0.3.0/schema/environmental-variable.json b/...chine-annotation-service-environment.json → .../0.3.0/schema/environmental-variable.json
@@ -1,25 +1,24 @@
 {
-  "$id": "https://schemas.dissco.tech/schemas/fdo-type/machine-annotation-service/0.3.0/machine-annotation-service-environment.json",
+  "$id": "https://schemas.dissco.tech/schemas/fdo-type/shared/0.3.0/environment-variable.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$comment": "Machine Annotation Service Environment Version 0.3.0",
-  "title": "MachineAnnotationServiceEnvironment",
+  "title": "EnvironmentalVariable",
   "type": "object",
-  "description": "Environmental variables to supply to the MAS, non-sensitive",
+  "description": "Environmental variables to supply to the a Digital Object, non-sensitive",
   "properties": {
-    "name": {
+    "schema:name": {
       "type": "string",
       "description": "The name of a non-sensitive property or environmental variable",
       "examples": [
         "server.port",
         "spring.profiles.active"
       ]
     },
-    "value": {
+    "schema:value": {
       "type": [
         "string",
         "integer",
-        "boolean",
-        "null"
+        "boolean"
       ],
       "description": "Value to be stored in the \"name\" field. NOT for sensitive information.",
       "examples": [
@@ -30,7 +29,7 @@
   },
   "additionalProperties": false,
   "required": [
-    "name",
-    "value"
+    "schema:name",
+    "schema:value"
   ]
 }
diff --git a/...ma/machine-annotation-service-secret.json → ...d-model/0.3.0/schema/secret-variable.json b/...ma/machine-annotation-service-secret.json → ...d-model/0.3.0/schema/secret-variable.json
@@ -1,30 +1,30 @@
 {
-  "$id": "https://schemas.dissco.tech/schemas/fdo-type/machine-annotation-service/0.3.0/machine-annotation-service-secret.json",
+  "$id": "https://schemas.dissco.tech/schemas/fdo-type/shared/0.3.0/secret-variable.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$comment": "Machine Annotation Service Environment Version 0.3.0",
-  "title": "MachineAnnotationServiceSecret",
+  "$comment": "Secret Variable Version 0.3.0",
+  "title": "SecretVariable",
   "type": "object",
-  "description": "Remote secrets to supply to the MAS",
+  "description": "Secret Variable that need to be supplied to an Digital Object",
   "properties": {
-    "secretName": {
+    "schema:name": {
       "type": "string",
       "description": "The name of an environmental variable stored remotely",
       "examples": [
         "database.password",
         "keycloak.secret"
       ]
     },
-    "secretKeyRef": {
+    "ods:secretKeyRef": {
       "type": "string",
       "description": "The name of the key stored in the secret store. NOT the secret's value.",
-      "example": [
+      "examples": [
         "db-password"
       ]
     }
   },
   "additionalProperties": false,
   "required": [
-    "name",
-    "secretKeyRef"
+    "schema:name",
+    "ods:secretKeyRef"
   ]
 }