v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-02-1354131442.5 KB

setup

factory

Update System Metadata

Update system identification metadata fields.

Metadata vs Configuration:

Metadata: Identification fields (chassis type, location, etc.)
Configuration: Operational hardware settings (requires setup mode)

Chassis Type Notes:

Setting to 'user' marks chassis as not yet determined
Allows completing setup while deferring chassis identification
Can be updated later without re-entering setup mode

Does Not Require Setup Mode - these are non-operational fields.

patch/api/v1/setup/metadata

Request body

chassis_type'croc_mini' | 'croc_xl' | 'kronos' | 'caiman' | 'user' nullable

Cable reel chassis type identifier.

Valid Chassis Types:

croc_mini - Compact design for smaller USVs
croc_xl - Extended capacity model
kronos - High-performance variant
caiman - Heavy-duty configuration
user - Not yet determined/configured

Usage: For tracking, support, and maintenance records

Note: Setting to 'user' indicates the chassis type has not been determined yet. This allows deferring the chassis type decision while completing other setup steps.

Example request

{
  "description": "Set chassis type for system identification",
  "summary": "Update Chassis Type",
  "value": {
    "chassis_type": "croc_xl"
  }
}

Response

Metadata update result with list of updated fields

successboolean required

Whether the metadata update was successful

updated_fieldsstring[] required

List of metadata fields that were successfully updated

messagestring nullable

Additional information about the update operation

Example response

{
  "description": "Chassis type updated successfully",
  "summary": "Successful Update",
  "value": {
    "message": "System metadata updated successfully",
    "success": true,
    "updated_fields": [
      "chassis_type"
    ]
  }
}