Add software and hardware fields to metadata schema (#462)

faucetsdn · Sep 23, 2022 · 47dab02 · 47dab02
1 parent 640f035
commit 47dab02
Show file tree

Hide file tree

Showing 8 changed files with 499 additions and 7 deletions.
diff --git a/.gencode_hash.txt b/.gencode_hash.txt
@@ -12,7 +12,7 @@ a8800ab8384de3b846af0d72cf310acf01644842b557e42eec20b69a0bfa1868  gencode/docs/e
 71fe25d3b17d1dc87b52c049a3235c20527f73e12ffa53fa4800a15e53f73732  gencode/docs/event_pointset.html
 7adf725427f285539b37abdad0c15f32e76bd6e1ec7d775527491597aef32875  gencode/docs/event_system.html
 43025f61381de050eae9680c3193a1d878a397d0b5515dd1063a1a993b0c41ea  gencode/docs/event_validation.html
-208956129b09bde2639068b0bb3282dce09b12edb5e775eeed0834fa4890a001  gencode/docs/metadata.html
+9ae793a641f2e053c5af734bf813cd2637a675330acb8d9e903ef03b4286e007  gencode/docs/metadata.html
 5d039d607af9ec75ee552dfe36b16c702687ea16f5663f41fc49b4533b86e00d  gencode/docs/properties.html
 162f8f3b8ca9491e7dc1d2569d4773acae51f93b07fa875a9ece218d9d4f8a89  gencode/docs/readme.md
 690d56e96c4e180e49e0abcba358ab1842ea06dd3f693918852a9de370c994d5  gencode/docs/reflect_config.html
@@ -88,15 +88,15 @@ b2274107ce0e4e663b2a35e2ca284e492ec683bd687f6b8d8b014d5f8be67233  gencode/java/u
 7de481ba531ea915a57cb6c5b23278db4fac6588354683cf63613b20c522af24  gencode/java/udmi/schema/SystemDiscoveryEvent.java
 247652dd11714452adc27ffa542e3d5915f8e9b7b255d181723d6fe1e897b565  gencode/java/udmi/schema/SystemEvent.java
 2cf23174ef4e2876511fb471d3f9fcb5cefe2fde324db844c2d0d505fd2c8844  gencode/java/udmi/schema/SystemHardware.java
-1c79bdb3da4c9127c75aa6660be0e62bfab1d1ee47c289637662fee2e37f1491  gencode/java/udmi/schema/SystemModel.java
+ceacfb4a1d0a4b4f4110b0e0717e57f2bbfd80ef18599d24fab19ddf497f399e  gencode/java/udmi/schema/SystemModel.java
 64e5b9a2c5699a3ca3b13dc6cb0243ff5b4c90908a14e3f11c5298ae89c8b261  gencode/java/udmi/schema/SystemState.java
 7d6dd13e368e7f073738fee69c15e18652a9b7d7ac63bde0a200f747e3aa1b1d  gencode/java/udmi/schema/TargetTestingModel.java
 d3968b92497e83a63f18cc0e74484a9807f1bb92db0c92d556ec2caaa143d645  gencode/java/udmi/schema/TestingModel.java
 8a7dd590b84944de25392b1437184608edd2f8305a183eced8b1b40eae27c6d2  gencode/java/udmi/schema/TestingSystemConfig.java
 ac6f8fd87c8986cce01e872460c15ff6fe71e3816f9bde610acfe25f7d38c8d4  gencode/java/udmi/schema/ValidationEvent.java
 f7d117dc8b9764acf0c95a13a2bfdfbdf31d1a8ec83a707448aa4d7391ef07e2  gencode/java/udmi/schema/ValidationState.java
 e007ddd1ceeae3603c85110c33e1bb4a418ff9c7a791ca0df25b7ea3caeafd36  gencode/java/udmi/schema/ValidationSummary.java
-033a86846fb9362a37d148f9696d223a2aae2a368452487cb6042407a316225f  gencode/python/udmi/schema/__init__.py
+07125fcc743ca05483e52fcd806488e98eb3716413c1f928a5d1896ed7f52496  gencode/python/udmi/schema/__init__.py
 4b25dd95f863059b761269f93adcae7049507924a1c6e74d6856849203c179db  gencode/python/udmi/schema/ancillary_properties.py
 5ecd6c542f33450cb4ce75d940a6dff4d3bd67d4b9de4aff5ee88abcc301dbff  gencode/python/udmi/schema/building_config.py
 dab4f5fca272ec48c2881bca2b6bc43786ada47fa1f6dd935c35f7ce0eb6b0f6  gencode/python/udmi/schema/building_translation.py
@@ -140,7 +140,8 @@ ae6a7bc93b520cdc90cd158f876a58e98a3e000402ebb1ca632f01ee492d408a  gencode/python
 4718368765cacc2cbf552a65346452a14690d0175e9cc921fc576a5c7691fa1d  gencode/python/udmi/schema/model_localnet_family.py
 abe431dc7702c80992b2c9736ab924d80d1033493036976f0cefa8c2108227be  gencode/python/udmi/schema/model_pointset.py
 1ad65c005d865b9259bfa239b2dc4cd1cde13d312ecbc7843bb61cc31d6cabde  gencode/python/udmi/schema/model_pointset_point.py
-3e34bfb5279c51a0a048d723ed0d91ebf82a614c22873c6425e058d55ac58df3  gencode/python/udmi/schema/model_system.py
+ee9c02c35438fb7d9aacb15a21ec7b35b533c1000d0bde044ec3923b1fdccca4  gencode/python/udmi/schema/model_system.py
+15b349141ebae651c6c3c5c313b197d49c8b2b44e8ff1b0639848ad42e5c4e63  gencode/python/udmi/schema/model_system_hardware.py
 aafe6e70c281152db958adf77a024e3e9fab8293927106297c5ec48c11f54e27  gencode/python/udmi/schema/model_testing.py
 5c50847e136a033ea511209238bb570499b43fbee6189dae06603132dcb9f01f  gencode/python/udmi/schema/model_testing_target.py
 a10a7e593d8747ea46c56da2c24c7b0501c10b190c5b66119cab8e71d2bdc0e6  gencode/python/udmi/schema/options_pubber.py

diff --git a/gencode/docs/metadata.html b/gencode/docs/metadata.html
diff --git a/gencode/java/udmi/schema/SystemModel.java b/gencode/java/udmi/schema/SystemModel.java
diff --git a/gencode/python/udmi/schema/__init__.py b/gencode/python/udmi/schema/__init__.py
diff --git a/gencode/python/udmi/schema/model_system.py b/gencode/python/udmi/schema/model_system.py
diff --git a/gencode/python/udmi/schema/model_system_hardware.py b/gencode/python/udmi/schema/model_system_hardware.py
diff --git a/schema/model_system.json b/schema/model_system.json
@@ -43,6 +43,21 @@
         "site"
       ]
     },
+    "hardware": {
+      "$ref": "file:model_system_hardware.json"
+    },
+    "software": {
+      "additionalProperties": false,
+      "description": "A collection of items which can be used to describe version of software running on a device",
+      "examples": ["firmware", "os", "driver"],
+      "type": "object",
+      "existingJavaType": "java.util.Map<String, String>",
+      "patternProperties": {
+        "^[a-z_]+$": {
+          "type": "string"
+        }
+      }
+    },    
     "physical_tag": {
       "description": "Information used to print a physical QR code label.",
       "type": "object",

diff --git a/schema/model_system_hardware.json b/schema/model_system_hardware.json
@@ -0,0 +1,33 @@
+{
+    "title": "SystemHardware",
+    "description": "A collection of fields which describe the physical hardware of the device.",
+    "type": "object",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "additionalProperties": false,
+    "properties": {
+      "make": {
+        "description": "The manufacturer of the device",
+        "type": "string",
+        "examples": ["Google"]
+      },
+      "model": {
+        "description": "The model of the device",
+        "examples" : ["Pixel 5", "Pixel 6", "Pixel 6 Pro"],
+        "type": "string"
+      },
+      "sku": {
+        "description": "A stock keeping unit which identifies the unique composition of a device, for example those with different hardware configurations",
+        "type": "string",
+        "examples": ["GF5KQ", "4215612"]
+      },
+      "rev": {
+        "description": "Hardware revision of the device",
+        "type": "string",
+        "examples": ["A", "B", "1"]
+      }
+    },
+    "required": [
+      "make",
+      "model"
+    ]
+  }