Merge pull request #229 from HewlettPackard/systems-api-docs

[MORPH-5865] Systems api docs

Author: sax6575

components/examples/system.json

@@ -0,0 +1,26 @@
+{
+  "system": {
+    "id": 1,
+    "name": "my-system",
+    "description": "My system description",
+    "type": { "id": 1, "name": "Generic", "code": "generic" },
+    "layout": { "id": 1, "name": "Default", "code": "generic-default" },
+    "status": "ok",
+    "statusMessage": null,
+    "enabled": true,
+    "externalId": "ext-1234",
+    "config": {},
+    "components": [
+      {
+        "id": 10,
+        "name": "Primary Node",
+        "type": { "id": 5, "code": "primary-node", "name": "Primary Node" },
+        "status": "ok",
+        "externalId": null,
+        "config": {}
+      }
+    ],
+    "dateCreated": "2026-01-01T00:00:00Z",
+    "lastUpdated": "2026-01-01T00:00:00Z"
+  }
+}

components/examples/systemCreateResponse.json

@@ -0,0 +1,4 @@
+{
+  "success": true,
+  "id": 42
+}

components/examples/systemInitializeRequest.json

@@ -0,0 +1,18 @@
+{
+  "system": {
+    "externalId": "ext-1234-updated",
+    "config": {
+      "region": "us-east-1"
+    },
+    "components": [
+      {
+        "typeCode": "primary-node",
+        "name": "Primary Node",
+        "externalId": "ext-comp-99",
+        "config": {
+          "hostname": "node1.example.com"
+        }
+      }
+    ]
+  }
+}

components/examples/systemInitializeResponse.json

@@ -0,0 +1,3 @@
+{
+  "success": true
+}

components/examples/systemRequest.json

@@ -0,0 +1,11 @@
+{
+  "system": {
+    "name": "my-system",
+    "description": "My system description",
+    "type": { "id": 1 },
+    "layout": { "id": 1 },
+    "enabled": true,
+    "externalId": "ext-1234",
+    "config": {}
+  }
+}

components/examples/systemTypeLayouts.json

@@ -0,0 +1,23 @@
+{
+  "systemTypeLayouts": [
+    {
+      "id": 1,
+      "name": "Default",
+      "code": "generic-default",
+      "componentTypes": [
+        {
+          "id": 5,
+          "code": "primary-node",
+          "name": "Primary Node",
+          "category": "compute"
+        },
+        {
+          "id": 6,
+          "code": "storage-volume",
+          "name": "Storage Volume",
+          "category": "storage"
+        }
+      ]
+    }
+  ]
+}

components/examples/systemTypes.json

@@ -0,0 +1,14 @@
+{
+  "systemTypes": [
+    {
+      "id": 1,
+      "name": "Generic",
+      "code": "generic"
+    },
+    {
+      "id": 2,
+      "name": "Kubernetes",
+      "code": "kubernetes"
+    }
+  ]
+}

components/examples/systemUninitializedRequest.json

@@ -0,0 +1,19 @@
+{
+  "system": {
+    "name": "my-system",
+    "description": "My system description",
+    "type": { "id": 1 },
+    "layout": { "id": 1 },
+    "enabled": true,
+    "externalId": "ext-1234",
+    "config": {},
+    "components": [
+      {
+        "typeCode": "primary-node",
+        "name": "Primary Node",
+        "externalId": "ext-comp-99",
+        "config": {}
+      }
+    ]
+  }
+}

components/examples/systemUninitializedResponse.json

@@ -0,0 +1,4 @@
+{
+  "success": true,
+  "id": 42
+}

components/examples/systemUpdateRequest.json

@@ -0,0 +1,7 @@
+{
+  "system": {
+    "name": "my-system-renamed",
+    "description": "Updated description",
+    "enabled": true
+  }
+}