diff --git a/openapi.yaml b/openapi.yaml index fff08dd8..c8b25777 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -783,6 +783,12 @@ paths: device_sn: type: string description: The serial number to assign to the device. + fleet_uids: + type: array + items: + type: string + description: The fleetUIDs to provision the device to. + nullable: true required: - product_uid responses: @@ -1202,7 +1208,7 @@ paths: items: type: string - name: since - description: Deprecated. + description: Deprecated. in: query required: false deprecated: true @@ -1294,7 +1300,7 @@ paths: items: type: string - name: since - description: Deprecated. + description: Deprecated. in: query required: false deprecated: true @@ -2195,7 +2201,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: [] @@ -2213,7 +2219,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: @@ -2300,7 +2306,7 @@ components: schema: type: string example: dev:000000000000000 - + firmwareTypeParam: name: firmwareType in: path @@ -2310,9 +2316,9 @@ components: enum: - host - notecard - + dfuActionParam: - name: action + name: action in: path required: true schema: @@ -2453,8 +2459,8 @@ components: type: string default: captured enum: - - captured - - uploaded + - captured + - uploaded example: uploaded cursorParam: @@ -2709,6 +2715,8 @@ components: items: type: string + + responses: ErrorResponse: description: The response body in case of an API error. @@ -4720,16 +4728,16 @@ 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 @@ -4737,7 +4745,8 @@ components: from_version: type: string metadata: - $ref: "#/components/schemas/UploadMetadata" + $ref: '#/components/schemas/UploadMetadata' + UserDfuStateMachineStatus: type: object @@ -4759,7 +4768,7 @@ components: version: type: string metadata: - $ref: "#/components/schemas/Firmware" + $ref: '#/components/schemas/Firmware' UploadMetadata: type: object @@ -4789,7 +4798,7 @@ components: notes: type: string firmware: - $ref: "#/components/schemas/Firmware" + $ref: '#/components/schemas/Firmware' Firmware: type: object @@ -4974,7 +4983,7 @@ components: type: array items: $ref: "#/components/schemas/DeviceDfuStateMachineNode" - + DeviceDfuStateMachineNode: type: object description: Represents a single request to update the host or Notecard firmware @@ -4990,4 +4999,4 @@ components: description: RFC3339 compatible datetime of when this status update happened description: type: string - description: Additional information + description: Additional information