Align the OpenAPI spec with the written spec

system-design/specification/margo-management-interface/workload-management-api-1.0.0.yaml

@@ -19,6 +19,7 @@ paths:
   /api/v1/onboarding/certificate:
     get:
       summary: Download Root CA certificate
+      security: []
       responses:
         '200':
           description: Root CA certificate
@@ -36,19 +37,27 @@ paths:
         content:
           application/json:
             schema:
+              type: object
+              required: [apiVersion, kind, certificate]
               properties:
-                public_certificate:
+                apiVersion:
+                  type: string
+                  description: API version identifier
+                kind:
+                  type: string
+                  enum: [OnboardingRequest]
+                  description: Resource kind
+                certificate:
                   description: Base64-encoded client certificate
                   type: string
-              type: object
         required: true
       responses:
         '201':
           content:
             application/json:
               schema:
                 properties:
-                  client_id:
+                  clientId:
                     type: string
                 type: object
           description: New client onboarded successfully.
@@ -304,7 +313,7 @@ paths:
         '404':
           description: Deployment not found for the given digest
 
-  /api/v1/clients/{clientId}/deployment/{deploymentId}/status:
+  /api/v1/clients/{clientId}/deployments/{deploymentId}/status:
     post:
       summary: Report deployment status
       security:
@@ -375,7 +384,7 @@ components:
         url:
           type: string
           description: >
-            Content-addressable retrieval endpoint of the form /api/v1/devices/{deviceId}/bundles/{digest} where {digest} equals bundle.digest.
+            Content-addressable retrieval endpoint of the form /api/v1/clients/{clientId}/bundles/{digest} where {digest} equals bundle.digest.
     DeploymentManifestRef:
       type: object
       description: >
@@ -400,7 +409,7 @@ components:
         url:
           type: string
           description: >
-            Content-addressable endpoint of the form /api/v1/devices/{deviceId}/deployments/{deploymentId}/{digest}. The {digest} MUST equal deployments[].digest; the referenced resource is immutable
+            Content-addressable endpoint of the form /api/v1/clients/{clientId}/deployments/{deploymentId}/{digest}. The {digest} MUST equal deployments[].digest; the referenced resource is immutable
     UnsignedAppStateManifest:
       type: object
       required:
@@ -428,7 +437,7 @@ components:
           type: string
         kind:
           type: string
-          enum: [DeviceCapabilities]
+          enum: [DeviceCapabilitiesManifest]
         properties:
           type: object
           required: [id, vendor, modelNumber, serialNumber, roles, resources]
@@ -448,17 +457,29 @@ components:
                 enum: [Standalone Cluster, Cluster Leader, Standalone Device]
             resources:
               type: object
-              required: [cpu, memory, storage]
+              required: [cpu, memory, storage, peripherals, interfaces]
               properties:
                 cpu:
                   type: object
+                  required: [cores]
                   properties:
                     cores:
                       type: number
+                    architecture:
+                      type: string
+                      enum: [amd64, x86_64, arm64, arm]
                 memory:
                   type: string
                 storage:
                   type: string
+                peripherals:
+                  type: array
+                  items:
+                    $ref: '#/components/schemas/DevicePeripheral'
+                interfaces:
+                  type: array
+                  items:
+                    $ref: '#/components/schemas/DeviceCommunicationInterface'
 
     ComponentStatus:
       type: object
@@ -468,7 +489,7 @@ components:
           type: string
         state:
           type: string
-          enum: [Pending, Installing, Installed, Failed, Removing, Removed, Updating, Updated]
+          enum: [pending, installing, installed, failed, removing, removed]
         error:
           type: object
           properties:
@@ -485,7 +506,7 @@ components:
           type: string
         kind:
           type: string
-          enum: [DeploymentStatus]
+          enum: [DeploymentStatusManifest]
         deploymentId:
           type: string
         status:
@@ -494,7 +515,7 @@ components:
           properties:
             state:
               type: string
-              enum: [Pending, Installing, Installed, Failed, Removing, Removed, Updating, Updated]
+              enum: [pending, installing, installed, failed, removing, removed]
             error:
               type: object
               properties:
@@ -507,6 +528,26 @@ components:
           items:
             $ref: '#/components/schemas/ComponentStatus'
 
+    DevicePeripheral:
+      type: object
+      required: [type]
+      properties:
+        type:
+          type: string
+          enum: [gpu, display, camera, microphone, speaker]
+        manufacturer:
+          type: string
+        model:
+          type: string
+
+    DeviceCommunicationInterface:
+      type: object
+      required: [type]
+      properties:
+        type:
+          type: string
+          enum: [ethernet, wifi, cellular, bluetooth, usb, canbus, rs232]
+
     # app deployment struct added here for ease of programming, the code generators will generate the structs
     # for the actual app deployment yaml and parsing would be easy to do
     appDeploymentManifest: