beta: Beta OpenAPI file replicated from Notehub commit 7d431d2

openapi.yaml

@@ -625,7 +625,10 @@ paths:
               properties:
                 label:
                   type: string
-                  description: The label for the Fleet.
+                  description: The label, or name,  for the Fleet.
+                smart_rule:
+                  $ref: "#/components/schemas/FleetRule"
+
 
       responses:
         "201":
@@ -669,6 +672,8 @@ paths:
                   items:
                     type: string
                   description: List of DeviceUIDs to remove from fleet
+                smart_rule:
+                  $ref: "#/components/schemas/FleetRule"
       responses:
         "200":
           description: Successful operation
@@ -691,6 +696,20 @@ paths:
         default:
           $ref: "#/components/responses/ErrorResponse"
 
+    get:
+      tags: [ "project" ]
+      operationId: getFleet
+      description: Get Fleet
+      security:
+        - api_key: [ ]
+      responses:
+        "200":
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Fleet"
+
   /v1/projects/{projectUID}/members:
     parameters:
       - $ref: "#/components/parameters/projectUIDParam"
@@ -1208,7 +1227,7 @@ paths:
             items:
               type: string
         - name: since
-          description: Deprecated.
+          description: Deprecated. 
           in: query
           required: false
           deprecated: true
@@ -1300,7 +1319,7 @@ paths:
             items:
               type: string
         - name: since
-          description: Deprecated.
+          description: Deprecated. 
           in: query
           required: false
           deprecated: true
@@ -2201,7 +2220,7 @@ paths:
   /v1/projects/{projectUID}/dfu/{firmwareType}/{action}:
     post:
       tags: ["project"]
-      operationId: dfuAction
+      operationId: dfuAction 
       description: Update/cancel host or notecard firmware updates
       security:
         - api_key: []
@@ -2219,7 +2238,7 @@ paths:
         - $ref: "#/components/parameters/productUIDQueryParam"
         - $ref: "#/components/parameters/skuParam"
       requestBody:
-        description: Which firmware in the case of an update action
+        description: Which firmware in the case of an update action 
         required: false
         content:
           application/json:
@@ -2232,6 +2251,7 @@ paths:
           $ref: "#/components/responses/ErrorResponse"
 
 components:
+
   securitySchemes:
     api_key:
       type: apiKey
@@ -2281,6 +2301,7 @@ components:
       schema:
         type: string
 
+
     fleetUIDsParam:
       name: fleetUIDs
       in: query
@@ -2306,7 +2327,7 @@ components:
       schema:
         type: string
       example: dev:000000000000000
-
+    
     firmwareTypeParam:
       name: firmwareType
       in: path
@@ -2316,9 +2337,9 @@ components:
         enum:
           - host
           - notecard
-
+    
     dfuActionParam:
-      name: action
+      name: action 
       in: path
       required: true
       schema:
@@ -2459,8 +2480,8 @@ components:
         type: string
         default: captured
         enum:
-          - captured
-          - uploaded
+        - captured
+        - uploaded
       example: uploaded
 
     cursorParam:
@@ -2715,6 +2736,8 @@ components:
         items:
           type: string
 
+
+
   responses:
     ErrorResponse:
       description: The response body in case of an API error.
@@ -3252,17 +3275,26 @@ components:
         - label
         - disable_devices_by_default
 
+    FleetRule:
+      type: string
+      description: JSONata expression that will be evaluated to determine device membership into this fleet, if the expression evaluates to a 1, the device will be included, if it evaluates to -1 it will be removed, and if it evaluates to 0 or errors it will be left unchanged.
+
     Fleet:
       type: object
       properties:
-        # NOTE: Leaving out is and is_like, for now.
         uid:
           type: string
+          description: Fleet UID
         label:
           type: string
+          description: Fleet label
         created:
           type: string
           format: date-time
+          description: RFC3339 timestamp in UTC
+        smart_rule:
+          $ref: "#/components/schemas/FleetRule"
+
       required:
         - uid
         - label
@@ -4726,24 +4758,25 @@ components:
       type: object
       properties:
         current_firmware:
-          $ref: "#/components/schemas/CurrentFirmware"
+          $ref: '#/components/schemas/CurrentFirmware'
         firmware_update:
-          $ref: "#/components/schemas/UserDfuStateMachine"
+          $ref: '#/components/schemas/UserDfuStateMachine'
           nullable: true
 
     UserDfuStateMachine:
       type: object
       properties:
         status:
-          $ref: "#/components/schemas/UserDfuStateMachineStatus"
+          $ref: '#/components/schemas/UserDfuStateMachineStatus'
         created:
           type: string
           format: date-time
           nullable: true
         from_version:
           type: string
         metadata:
-          $ref: "#/components/schemas/UploadMetadata"
+          $ref: '#/components/schemas/UploadMetadata'
+
 
     UserDfuStateMachineStatus:
       type: object
@@ -4765,7 +4798,7 @@ components:
         version:
           type: string
         metadata:
-          $ref: "#/components/schemas/Firmware"
+          $ref: '#/components/schemas/Firmware'
 
     UploadMetadata:
       type: object
@@ -4795,7 +4828,7 @@ components:
         notes:
           type: string
         firmware:
-          $ref: "#/components/schemas/Firmware"
+          $ref: '#/components/schemas/Firmware'
 
     Firmware:
       type: object
@@ -4980,7 +5013,7 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/DeviceDfuStateMachineNode"
-
+    
     DeviceDfuStateMachineNode:
       type: object
       description: Represents a single request to update the host or Notecard firmware
@@ -4996,4 +5029,4 @@ components:
           description: RFC3339 compatible datetime of when this status update happened
         description:
           type: string
-          description: Additional information
+          description: Additional information