only checking in the bare minimum to give structure to the APIs

Author: pjohnst5

cns/api.go

@@ -33,9 +33,7 @@ const (
 	V1Prefix                      = "/v0.1"
 	V2Prefix                      = "/v0.2"
 	EndpointPath                  = "/network/endpoints/"
-	// IBDevice API paths
-	IBDevicesPodPath = "/ibdevices/pod" // POST /ibdevices/pod
-	IBDevicesPath    = "/ibdevices/"    // GET /ibdevices/{mac-address-of-device}
+	IBDevicesPath                 = "/ibdevices"
 	// Service Fabric SWIFTV2 mode
 	StandaloneSWIFTV2 SWIFTV2Mode = "StandaloneSWIFTV2"
 	// K8s SWIFTV2 mode
@@ -387,27 +385,16 @@ type GetVMUniqueIDResponse struct {
 	VMUniqueID string   `json:"vmuniqueid"`
 }
 
-// IBDevice API Contracts
-
-// AssignIBDevicesToPodRequest represents the request to assign InfiniBand devices to a pod
-// POST /ibdevices/pod
-type AssignIBDevicesToPodRequest struct {
-	PodID        string   `json:"podID"`        // podname-podnamespace format
-	MACAddresses []string `json:"macAddresses"` // Array of MAC addresses like ["60:45:bd:a4:b5:7a", "7c:1e:52:07:11:36"]
-}
-
 // AssignIBDevicesToPodResponse represents the response for assigning InfiniBand devices to a pod
 type AssignIBDevicesToPodResponse struct {
-	ErrorCode infiniband.ErrorCode `json:"errorCode"` // Error code if applicable
-	Message   string               `json:"message"`   // Additional message or error description
+	Message string `json:"message"` // Additional message or error description
 }
 
-// GET /ibdevices/{mac-address-of-device}
 // GetIBDeviceStatusResponse represents the response containing InfiniBand device programming status
 type GetIBDeviceStatusResponse struct {
-	MACAddress string               `json:"macAddress"` // MAC address of the device
-	PodID      string               `json:"podID"`      // Pod that the device is assigned to
-	Status     infiniband.Status    `json:"status"`     // Device status (e.g., "pendingProgramming", "error", "programmed", "pendingDeletion", "available")
-	ErrorCode  infiniband.ErrorCode `json:"errorCode"`  // Error code if applicable
-	Message    string               `json:"message"`    // Additional message or error description
+	MACAddress   string            `json:"macAddress"`   // MAC address of the device
+	PodNamespace string            `json:"podNamespace"` // Namespace of pod to which the device is assigned, if any
+	PodName      string            `json:"podName"`      // Name of pod to which the device is assigned, if any
+	Status       infiniband.Status `json:"status"`       // Device status (e.g., "Available", "ProgrammingPending", etc.)"
+	Message      string            `json:"message"`      // Additional message or error description
 }

cns/swagger.yaml

@@ -120,18 +120,35 @@ paths:
               schema:
                 $ref: "#/components/schemas/UnpublishNetworkContainerResponse"
 
-  /ibdevices/pod:
+  /ibdevices:assign:
     post:
-      summary: Assigns IB devices to a pod
-      description: >-
-        Assigns the specified IB devices to the pod identified by PodID. The
-        MAC addresses of the devices are provided in the request body.
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/AssignIBDevicesToPodRequest"
+      summary: Assign IB devices to a pod
+      description: >
+        Assigns one or more Infiniband devices by MAC address to a given pod.
+      parameters:
+        - name: ibmacs
+          in: query
+          required: true
+          description: Comma-separated list of IB device MAC addresses.
+          schema:
+            type: array
+            items:
+              type: string
+            example: ["60:45:bd:a4:b5:7a", "7c:1e:52:07:11:36"]
+        - name: podnamespace
+          in: query
+          required: true
+          description: The namespace of the target pod.
+          schema:
+            type: string
+            example: "podnamespace"
+        - name: podname
+          in: query
+          required: true
+          description: The name of the target pod.
+          schema:
+            type: string
+            example: "podname"
       responses:
         '200':
           description: >-
@@ -142,31 +159,32 @@ paths:
                 $ref: "#/components/schemas/AssignIBDevicesToPodResponse"
         '404':
           description: >-
-            The pod specified by PodID was not found
+            The pod specified by PodID was not found.
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/AssignIBDevicesToPodResponse"
         '400':
           description: >-
-            One of the IB devices specified is not available
+            One of the IB devices specified is not available.
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/AssignIBDevicesToPodResponse"
 
-  /ibdevices/{macaddress}:
+  /ibdevices:
     get:
       summary: Get status of an IB device
       description: >-
-        Retrieves the current status of the specified IB device.
+        Retrieves the current programming status of the specified IB device.
       parameters:
-        - name: macaddress
-          in: path
+        - name: ibmac
+          in: query
           required: true
-          description: The MAC address of the IB device (with colons ":")
+          description: The MAC address of the IB device.
           schema:
             type: string
+            example: "60:45:bd:a4:b5:7a"
       responses:
         '200':
           description: >-
@@ -433,11 +451,8 @@ components:
     AssignIBDevicesToPodResponse:
       type: object
       required:
-        - ErrorCode
         - Message
       properties:
-        ErrorCode:
-          $ref: "#/components/schemas/ErrorCode"
         Message:
           type: string
           description: Human-readable message or error description
@@ -446,50 +461,25 @@ components:
       type: object
       required:
         - MACAddress
-        - PodID
+        - PodNamespace
+        - PodName
         - Status
-        - ErrorCode
         - Message
       properties:
         MACAddress:
           type: string
           description: MAC address of the IB device
-        PodID:
+        PodNamespace:
+          type: string
+          description: namespace of the pod to which the device is assigned, if any
+        PodName:
           type: string
-          description: podname-podnamespace of the pod to which the device is assigned, if any
+          description: name of the pod to which the device is assigned, if any
         Status:
           $ref: "#/components/schemas/Status"
-        ErrorCode:
-          $ref: "#/components/schemas/ErrorCode"
         Message:
           type: string
           description: Human-readable message or error description
-    
-    ErrorCode:
-      type: integer
-      description: Pre-defined error code of what went wrong, if anything (see cns/types/infiniband/errorcodes.go)
-      oneOf:
-      - title: Success
-        const: 0
-        description: Successful operation
-      - title: PodNotFound
-        const: 1
-        description: Pod not found
-      - title: DeviceUnavailable
-        const: 2
-        description: Device is unavailable
-      - title: DeviceNotFound
-        const: 3
-        description: Device not found
-      - title: AnnotationNotFound
-        const: 4
-        description: Annotation not found on pod
-      - title: PodAlreadyAllocated
-        const: 5
-        description: Pod was already assigned IB devices (and new ones don't match)
-      - title: InternalProgrammingError
-        const: 6
-        description: Something went wrong programming the devices
 
     Status:
       type: integer