wicketd.json

{
  "openapi": "3.0.3",
  "info": {
    "title": "Oxide Technician Port Control Service",
    "description": "API for use by the technician port TUI: wicket",
    "contact": {
      "url": "https://oxide.computer",
      "email": "api@oxide.computer"
    },
    "version": "0.0.1"
  },
  "paths": {
    "/abort-update/{type}/{slot}": {
      "post": {
        "summary": "Forcibly cancels a running update.",
        "description": "This is a potentially dangerous operation, but one that is sometimes required. A machine reset might be required after this operation completes.",
        "operationId": "post_abort_update",
        "parameters": [
          {
            "in": "path",
            "name": "slot",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "uint16",
              "minimum": 0
            }
          },
          {
            "in": "path",
            "name": "type",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/SpType"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AbortUpdateOptions"
              }
            }
          },
          "required": true
        },
        "responses": {
          "204": {
            "description": "resource updated"
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    },
    "/artifacts-and-event-reports": {
      "get": {
        "summary": "An endpoint used to report all available artifacts and event reports.",
        "description": "The order of the returned artifacts is unspecified, and may change between calls even if the total set of artifacts has not.",
        "operationId": "get_artifacts_and_event_reports",
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetArtifactsAndEventReportsResponse"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    },
    "/baseboard": {
      "get": {
        "summary": "Report the configured baseboard details.",
        "operationId": "get_baseboard",
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetBaseboardResponse"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    },
    "/bootstrap-sleds": {
      "get": {
        "summary": "Get wicketd's current view of all sleds visible on the bootstrap network.",
        "operationId": "get_bootstrap_sleds",
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BootstrapSledIps"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    },
    "/clear-update-state": {
      "post": {
        "summary": "Resets update state for a sled.",
        "description": "Use this to clear update state after a failed update.",
        "operationId": "post_clear_update_state",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ClearUpdateStateParams"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClearUpdateStateResponse"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    },
    "/ignition/{type}/{slot}/{command}": {
      "post": {
        "summary": "Send an ignition command targeting a specific SP.",
        "description": "This endpoint acts as a proxy to the MGS endpoint performing the same function, allowing wicket to communicate exclusively with wicketd (even though wicketd adds no meaningful functionality here beyond what MGS offers).",
        "operationId": "post_ignition_command",
        "parameters": [
          {
            "in": "path",
            "name": "command",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/IgnitionCommand"
            }
          },
          {
            "in": "path",
            "name": "slot",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "uint16",
              "minimum": 0
            }
          },
          {
            "in": "path",
            "name": "type",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/SpType"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "resource updated"
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    },
    "/inventory": {
      "get": {
        "summary": "A status endpoint used to report high level information known to",
        "description": "wicketd.\n\nThis endpoint can be polled to see if there have been state changes in the system that are useful to report to wicket.\n\nWicket, and possibly other callers, will retrieve the changed information, with follow up calls.",
        "operationId": "get_inventory",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GetInventoryParams"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetInventoryResponse"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    },
    "/preflight/uplink": {
      "get": {
        "summary": "Get the report for the most recent (or still running) preflight uplink",
        "description": "check.",
        "operationId": "get_preflight_uplink_report",
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EventReportForUplinkPreflightCheckSpec"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      },
      "post": {
        "summary": "Start a preflight check for uplink configuration.",
        "operationId": "post_start_preflight_uplink_check",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PreflightUplinkCheckOptions"
              }
            }
          },
          "required": true
        },
        "responses": {
          "204": {
            "description": "resource updated"
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    },
    "/rack-setup": {
      "get": {
        "summary": "Query current state of rack setup.",
        "operationId": "get_rack_setup_state",
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RackOperationStatus"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    },
    "/rack-setup/config": {
      "get": {
        "summary": "Get the current status of the user-provided (or system-default-provided, in",
        "description": "some cases) RSS configuration.",
        "operationId": "get_rss_config",
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CurrentRssUserConfig"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    },
    "/rack-setup/config/bgp/auth-key": {
      "get": {
        "summary": "Return information about BGP authentication keys, including checking",
        "description": "validity of keys.\n\nProduces an error if the rack setup config wasn't set, or if any of the requested key IDs weren't found.",
        "operationId": "get_bgp_auth_key_info",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GetBgpAuthKeyParams"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetBgpAuthKeyInfoResponse"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    },
    "/rack-setup/config/multirack": {
      "get": {
        "summary": "Get the current status of the multirack join configuration.",
        "operationId": "get_multirack_join_config",
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CurrentMultirackJoinUserConfig"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      },
      "put": {
        "summary": "Upload a configuration for joining this rack into an existing regional",
        "description": "cluster.\n\nA multirack join configuration is mutually exclusive with an RSS config.",
        "operationId": "put_multirack_join_config",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MultirackJoinConfigBaseUserInput"
              }
            }
          },
          "required": true
        },
        "responses": {
          "204": {
            "description": "resource updated"
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    },
    "/reload-config": {
      "post": {
        "summary": "Instruct wicketd to reload its SMF config properties.",
        "description": "The only expected client of this endpoint is `curl` from wicketd's SMF `refresh` method, but other clients hitting it is harmless.",
        "operationId": "post_reload_config",
        "responses": {
          "204": {
            "description": "resource updated"
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    },
    "/update": {
      "post": {
        "summary": "An endpoint to start updating one or more sleds, switches and PSCs.",
        "operationId": "post_start_update",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StartUpdateParams"
              }
            }
          },
          "required": true
        },
        "responses": {
          "204": {
            "description": "resource updated"
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    },
    "/update/{type}/{slot}": {
      "get": {
        "summary": "An endpoint to get the status of any update being performed or recently",
        "description": "completed on a single SP.",
        "operationId": "get_update_sp",
        "parameters": [
          {
            "in": "path",
            "name": "slot",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "uint16",
              "minimum": 0
            }
          },
          {
            "in": "path",
            "name": "type",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/SpType"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EventReportForWicketdEngineSpec"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AbortUpdateOptions": {
        "type": "object",
        "properties": {
          "message": {
            "description": "The message to abort the update with.",
            "type": "string"
          },
          "test_error": {
            "nullable": true,
            "description": "If passed in, fails the force cancel update operation with a simulated error.",
            "allOf": [
              {
                "$ref": "#/components/schemas/UpdateTestError"
              }
            ]
          }
        },
        "required": [
          "message"
        ]
      },
      "AllowedSourceIps": {
        "description": "Description of source IPs allowed to reach rack services.",
        "oneOf": [
          {
            "description": "Allow traffic from any external IP address.",
            "type": "object",
            "properties": {
              "allow": {
                "type": "string",
                "enum": [
                  "any"
                ]
              }
            },
            "required": [
              "allow"
            ]
          },
          {
            "description": "Restrict access to a specific set of source IP addresses or subnets.\n\nAll others are prevented from reaching rack services.",
            "type": "object",
            "properties": {
              "allow": {
                "type": "string",
                "enum": [
                  "list"
                ]
              },
              "ips": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/IpNet"
                }
              }
            },
            "required": [
              "allow",
              "ips"
            ]
          }
        ]
      },
      "ApplicationDescriptor": {
        "description": "An Application Descriptor describes the supported datapath configurations.\n\nThis is a CMIS-specific concept. It's used for modules to advertise how it can be used by the host. Each application describes the host-side electrical interface; the media-side interface; the number of lanes required; etc.\n\nHost-side software can select one of these applications to instruct the module to use a specific set of lanes, with the interface on either side of the module.",
        "type": "object",
        "properties": {
          "host_id": {
            "description": "The electrical interface with the host side.",
            "type": "string"
          },
          "host_lane_assignment_options": {
            "description": "The lanes on the host-side supporting this application.\n\nThis is a bit mask with a 1 identifying the lowest lane in a consecutive group of lanes to which the application can be assigned. This must be used with the `host_lane_count`. For example a value of `0b0000_0001` with a host lane count of 4 indicates that the first 4 lanes may be used in this application.\n\nAn application may support starting from multiple lanes.",
            "type": "integer",
            "format": "uint8",
            "minimum": 0
          },
          "host_lane_count": {
            "description": "The number of host-side lanes.",
            "type": "integer",
            "format": "uint8",
            "minimum": 0
          },
          "media_id": {
            "description": "The interface, optical or copper, with the media side.",
            "allOf": [
              {
                "$ref": "#/components/schemas/MediaInterfaceId"
              }
            ]
          },
          "media_lane_assignment_options": {
            "description": "The lanes on the media-side supporting this application.\n\nSee `host_lane_assignment_options` for details.",
            "type": "integer",
            "format": "uint8",
            "minimum": 0
          },
          "media_lane_count": {
            "description": "The number of media-side lanes.",
            "type": "integer",
            "format": "uint8",
            "minimum": 0
          }
        },
        "required": [
          "host_id",
          "host_lane_assignment_options",
          "host_lane_count",
          "media_id",
          "media_lane_assignment_options",
          "media_lane_count"
        ]
      },
      "ArtifactId": {
        "description": "The identifying components of an [`Artifact`], sent over the wire from wicketd to the wicket client to show versions of artifacts we will be updating to.",
        "type": "object",
        "properties": {
          "tags": {
            "description": "The Tufaceous tags used to select the artifact.",
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "version": {
            "description": "The artifact's version string.",
            "allOf": [
              {
                "$ref": "#/components/schemas/ArtifactVersion"
              }
            ]
          }
        },
        "required": [
          "tags",
          "version"
        ]
      },
      "ArtifactVersion": {
        "description": "An artifact version.\n\nThis is a freeform identifier with some basic validation. It may be the serialized form of a semver version, or a custom identifier that uses the same character set as a semver, plus `_`.\n\nThe exact pattern accepted is `^[a-zA-Z0-9._+-]{1,63}$`.\n\n# Ord implementation\n\n`ArtifactVersion`s are not intended to be sorted, just compared for equality. `ArtifactVersion` implements `Ord` only for storage within sorted collections.",
        "type": "string",
        "pattern": "^[a-zA-Z0-9._+-]{1,63}$"
      },
      "Aux1Monitor": {
        "description": "The first auxlliary CMIS monitor.",
        "oneOf": [
          {
            "description": "The monitored property is custom, i.e., part-specific.",
            "type": "object",
            "properties": {
              "custom": {
                "type": "array",
                "items": {
                  "type": "integer",
                  "format": "uint8",
                  "minimum": 0
                },
                "minItems": 2,
                "maxItems": 2
              }
            },
            "required": [
              "custom"
            ],
            "additionalProperties": false
          },
          {
            "description": "The current of the laser thermoelectric cooler.\n\nFor actively-cooled laser systems, this specifies the percentage of the maximum current the thermoelectric cooler supports. If the percentage is positive, the cooler is heating the laser. If negative, the cooler is cooling the laser.",
            "type": "object",
            "properties": {
              "tec_current": {
                "type": "number",
                "format": "float"
              }
            },
            "required": [
              "tec_current"
            ],
            "additionalProperties": false
          }
        ]
      },
      "Aux2Monitor": {
        "description": "The second auxlliary CMIS monitor.",
        "oneOf": [
          {
            "description": "The temperature of the laser itself (degrees C).",
            "type": "object",
            "properties": {
              "laser_temperature": {
                "type": "number",
                "format": "float"
              }
            },
            "required": [
              "laser_temperature"
            ],
            "additionalProperties": false
          },
          {
            "description": "The current of the laser thermoelectric cooler.\n\nFor actively-cooled laser systems, this specifies the percentage of the maximum current the thermoelectric cooler supports. If the percentage is positive, the cooler is heating the laser. If negative, the cooler is cooling the laser.",
            "type": "object",
            "properties": {
              "tec_current": {
                "type": "number",
                "format": "float"
              }
            },
            "required": [
              "tec_current"
            ],
            "additionalProperties": false
          }
        ]
      },
      "Aux3Monitor": {
        "description": "The third auxlliary CMIS monitor.",
        "oneOf": [
          {
            "description": "The temperature of the laser itself (degrees C).",
            "type": "object",
            "properties": {
              "laser_temperature": {
                "type": "number",
                "format": "float"
              }
            },
            "required": [
              "laser_temperature"
            ],
            "additionalProperties": false
          },
          {
            "description": "Measured voltage of an additional power supply (Volts).",
            "type": "object",
            "properties": {
              "additional_supply_voltage": {
                "type": "number",
                "format": "float"
              }
            },
            "required": [
              "additional_supply_voltage"
            ],
            "additionalProperties": false
          }
        ]
      },
      "AuxMonitors": {
        "description": "Auxlliary monitored values for CMIS modules.",
        "type": "object",
        "properties": {
          "aux1": {
            "nullable": true,
            "description": "Auxlliary monitor 1, either a custom value or TEC current.",
            "allOf": [
              {
                "$ref": "#/components/schemas/Aux1Monitor"
              }
            ]
          },
          "aux2": {
            "nullable": true,
            "description": "Auxlliary monitor 1, either laser temperature or TEC current.",
            "allOf": [
              {
                "$ref": "#/components/schemas/Aux2Monitor"
              }
            ]
          },
          "aux3": {
            "nullable": true,
            "description": "Auxlliary monitor 1, either laser temperature or additional supply voltage.",
            "allOf": [
              {
                "$ref": "#/components/schemas/Aux3Monitor"
              }
            ]
          },
          "custom": {
            "nullable": true,
            "description": "A custom monitor. The value here is entirely vendor- and part-specific, so the part's data sheet must be consulted. The value may be either a signed or unsigned 16-bit integer, and so is included as raw bytes.",
            "type": "array",
            "items": {
              "type": "integer",
              "format": "uint8",
              "minimum": 0
            },
            "minItems": 2,
            "maxItems": 2
          }
        }
      },
      "BaseboardId": {
        "description": "A representation of a Baseboard ID as used in the inventory subsystem.\n\nThis type is essentially the same as a `Baseboard` except it doesn't have a revision or HW type (Gimlet, PC, Unknown).",
        "type": "object",
        "properties": {
          "part_number": {
            "description": "Oxide Part Number",
            "type": "string"
          },
          "serial_number": {
            "description": "Serial number (unique for a given part number)",
            "type": "string"
          }
        },
        "required": [
          "part_number",
          "serial_number"
        ]
      },
      "BgpAuthKeyId": {
        "description": "The key identifier for authentication to use with a BGP peer.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Name"
          }
        ]
      },
      "BgpAuthKeyInfo": {
        "description": "Describes insensitive information about a BGP authentication key.\n\nThis information is considered okay to display in the UI.",
        "oneOf": [
          {
            "description": "TCP-MD5 authentication.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "tcp_md5"
                ]
              },
              "sha256": {
                "description": "A SHA-256 digest of the key.",
                "x-rust-type": {
                  "crate": "byte-wrapper",
                  "path": "byte_wrapper::HexArray::<32>",
                  "version": "0.2.0"
                },
                "type": "string",
                "pattern": "^[0-9a-fA-F]{64}$",
                "minLength": 64,
                "maxLength": 64
              }
            },
            "required": [
              "kind",
              "sha256"
            ]
          }
        ]
      },
      "BgpAuthKeyStatus": {
        "description": "The status of a BGP authentication key.\n\nThis is part of a wicketd response, but is returned here because our tooling turns BTreeMaps into HashMaps. So we use a `replace` directive instead.",
        "oneOf": [
          {
            "description": "The key was specified but hasn't been set yet.",
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "unset"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "description": "The key has been set.",
            "type": "object",
            "properties": {
              "info": {
                "description": "Information about the key.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/BgpAuthKeyInfo"
                  }
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "set"
                ]
              }
            },
            "required": [
              "info",
              "status"
            ]
          }
        ]
      },
      "BgpConfig": {
        "type": "object",
        "properties": {
          "asn": {
            "description": "The autonomous system number for the BGP configuration.",
            "type": "integer",
            "format": "uint32",
            "minimum": 0
          },
          "checker": {
            "nullable": true,
            "description": "Checker to apply to incoming messages.",
            "default": null,
            "type": "string"
          },
          "max_paths": {
            "description": "Maximum number of paths to use when multiple \"best paths\" exist",
            "default": 1,
            "allOf": [
              {
                "$ref": "#/components/schemas/MaxPathConfig"
              }
            ]
          },
          "originate": {
            "description": "The set of prefixes for the BGP router to originate.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IpNet"
            }
          },
          "shaper": {
            "nullable": true,
            "description": "Shaper to apply to outgoing messages.",
            "default": null,
            "type": "string"
          }
        },
        "required": [
          "asn",
          "originate"
        ]
      },
      "BootstrapSledDescription": {
        "type": "object",
        "properties": {
          "baseboard_id": {
            "$ref": "#/components/schemas/BaseboardId"
          },
          "bootstrap_ip": {
            "nullable": true,
            "description": "The sled's bootstrap address, if the host is on and we've discovered it on the bootstrap network.",
            "type": "string",
            "format": "ipv6"
          },
          "id": {
            "$ref": "#/components/schemas/SpIdentifier"
          }
        },
        "required": [
          "baseboard_id",
          "id"
        ]
      },
      "BootstrapSledIp": {
        "type": "object",
        "properties": {
          "baseboard": {
            "$ref": "#/components/schemas/BaseboardId"
          },
          "ip": {
            "type": "string",
            "format": "ipv6"
          }
        },
        "required": [
          "baseboard",
          "ip"
        ]
      },
      "BootstrapSledIps": {
        "type": "object",
        "properties": {
          "sleds": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BootstrapSledIp"
            }
          }
        },
        "required": [
          "sleds"
        ]
      },
      "ClearUpdateStateOptions": {
        "type": "object",
        "properties": {
          "test_error": {
            "nullable": true,
            "description": "If passed in, fails the clear update state operation with a simulated error.",
            "allOf": [
              {
                "$ref": "#/components/schemas/UpdateTestError"
              }
            ]
          }
        }
      },
      "ClearUpdateStateParams": {
        "type": "object",
        "properties": {
          "options": {
            "description": "Options for clearing update state",
            "allOf": [
              {
                "$ref": "#/components/schemas/ClearUpdateStateOptions"
              }
            ]
          },
          "targets": {
            "description": "The SP identifiers to clear the update state for.",
            "allOf": [
              {
                "$ref": "#/components/schemas/UpdateTargets"
              }
            ]
          }
        },
        "required": [
          "options",
          "targets"
        ]
      },
      "ClearUpdateStateResponse": {
        "description": "Response to an instruction to clear update data.",
        "type": "object",
        "properties": {
          "cleared": {
            "description": "The SPs for which update data was cleared.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SpIdentifier"
            },
            "uniqueItems": true
          },
          "no_update_data": {
            "description": "The SPs that had no update state to clear.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SpIdentifier"
            },
            "uniqueItems": true
          }
        },
        "required": [
          "cleared",
          "no_update_data"
        ]
      },
      "CmisDatapath": {
        "description": "A datapath in a CMIS module.\n\nIn contrast to SFF-8636, CMIS makes first-class the concept of a datapath: a set of lanes and all the associated machinery involved in the transfer of data. This includes:\n\n- The \"application descriptor\" which is the host and media interfaces, and the lanes on each side used to transfer data; - The state of the datapath in a well-defined finite state machine (see CMIS 5.0 section 6.3.3); - The flags indicating how the datapath components are operating, such as receiving an input Rx signal or whether the transmitter is disabled.",
        "type": "object",
        "properties": {
          "application": {
            "description": "The application descriptor for this datapath.",
            "allOf": [
              {
                "$ref": "#/components/schemas/ApplicationDescriptor"
              }
            ]
          },
          "lane_status": {
            "description": "The status bits for each lane in the datapath.",
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/CmisLaneStatus"
            }
          }
        },
        "required": [
          "application",
          "lane_status"
        ]
      },
      "CmisLaneStatus": {
        "description": "The status of a single CMIS lane.\n\nIf any particular control or status value is unsupported by a module, it is `None`.",
        "type": "object",
        "properties": {
          "rx_auto_squelch_disable": {
            "nullable": true,
            "description": "Whether the host-side has disabled the Rx auto-squelch.\n\nThe module can implement automatic squelching of the Rx output, if the media-side input signal isn't valid. This indicates whether the host has disabled such a setting.",
            "type": "boolean"
          },
          "rx_lol": {
            "nullable": true,
            "description": "Media-side loss of lock flag.\n\nThis is true if the module is not able to extract a clock signal from the media-side signal (usually optical).",
            "type": "boolean"
          },
          "rx_los": {
            "nullable": true,
            "description": "Media-side loss of signal flag.\n\nThis is true if there is no detected input signal from the media-side (usually optical).",
            "type": "boolean"
          },
          "rx_output_enabled": {
            "nullable": true,
            "description": "Whether the Rx output is enabled.\n\nThe host may control this to disable the electrical output from the module to the host.",
            "type": "boolean"
          },
          "rx_output_polarity": {
            "nullable": true,
            "description": "The Rx output polarity.\n\nThis indicates a host-side control that flips the polarity of the host-side output signal.",
            "allOf": [
              {
                "$ref": "#/components/schemas/LanePolarity"
              }
            ]
          },
          "rx_output_status": {
            "description": "Status of host-side Rx output.\n\nThis indicates whether the Rx output is sending a valid signal to the host. Note that this is `Invalid` if the output is either muted (such as squelched) or explicitly disabled.",
            "allOf": [
              {
                "$ref": "#/components/schemas/OutputStatus"
              }
            ]
          },
          "state": {
            "description": "The datapath state of this lane.\n\nSee CMIS 5.0 section 8.9.1 for details.",
            "type": "string"
          },
          "tx_adaptive_eq_fail": {
            "nullable": true,
            "description": "A failure in the Tx adaptive input equalization.",
            "type": "boolean"
          },
          "tx_auto_squelch_disable": {
            "nullable": true,
            "description": "Whether the host-side has disabled the Tx auto-squelch.\n\nThe module can implement automatic squelching of the Tx output, if the host-side input signal isn't valid. This indicates whether the host has disabled such a setting.",
            "type": "boolean"
          },
          "tx_failure": {
            "nullable": true,
            "description": "General Tx failure flag.\n\nThis indicates that an internal and unspecified malfunction has occurred on the Tx lane.",
            "type": "boolean"
          },
          "tx_force_squelch": {
            "nullable": true,
            "description": "Whether the host-side has force-squelched the Tx output.\n\nThis indicates that the host can _force_ squelching the output if the signal is not valid.",
            "type": "boolean"
          },
          "tx_input_polarity": {
            "nullable": true,
            "description": "The Tx input polarity.\n\nThis indicates a host-side control that flips the polarity of the host-side input signal.",
            "allOf": [
              {
                "$ref": "#/components/schemas/LanePolarity"
              }
            ]
          },
          "tx_lol": {
            "nullable": true,
            "description": "Host-side loss of lock flag.\n\nThis is true if the module is not able to extract a clock signal from the host-side electrical signal.",
            "type": "boolean"
          },
          "tx_los": {
            "nullable": true,
            "description": "Host-side loss of signal flag.\n\nThis is true if there is no detected electrical signal from the host-side serdes.",
            "type": "boolean"
          },
          "tx_output_enabled": {
            "nullable": true,
            "description": "Whether the Tx output is enabled.",
            "type": "boolean"
          },
          "tx_output_status": {
            "description": "Status of media-side Tx output.\n\nThis indicates whether the Rx output is sending a valid signal to the media itself. Note that this is `Invalid` if the output is either muted (such as squelched) or explicitly disabled.",
            "allOf": [
              {
                "$ref": "#/components/schemas/OutputStatus"
              }
            ]
          }
        },
        "required": [
          "rx_output_status",
          "state",
          "tx_output_status"
        ]
      },
      "CurrentMultirackJoinUserConfig": {
        "description": "A version of the multirack join configuration which contains learned bootstrap sleds and a redacted form of BGP auth keys if they exist.\n\nThis is returned to the user via wicketd and displayed in wicket.\n\nNote that there are no optional fields here unlike in `CurrentRssUserConfigInsensitive`. This is because wicketd defaults to filling in an empty RSS config for backwards compatibility and allows uploading BGP auth keys before actually uploading the RSS config. However, since we never default to an empty version of the `CurrentMultirackJoinConfig`, we can only fill in the BGP auth keys for this structure after the `MultirackJoinConfigBaseUserInput` is uploaded from a user.",
        "type": "object",
        "properties": {
          "bgp_auth_keys": {
            "$ref": "#/components/schemas/GetBgpAuthKeyInfoResponse"
          },
          "bootstrap_sleds": {
            "title": "IdOrdMap",
            "x-rust-type": {
              "crate": "iddqd",
              "parameters": [
                {
                  "$ref": "#/components/schemas/BootstrapSledDescription"
                }
              ],
              "path": "iddqd::IdOrdMap",
              "version": "*"
            },
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BootstrapSledDescription"
            },
            "uniqueItems": true
          },
          "rack_network_config": {
            "$ref": "#/components/schemas/UserSpecifiedRackNetworkConfig"
          }
        },
        "required": [
          "bgp_auth_keys",
          "bootstrap_sleds",
          "rack_network_config"
        ]
      },
      "CurrentRssUserConfig": {
        "type": "object",
        "properties": {
          "insensitive": {
            "$ref": "#/components/schemas/CurrentRssUserConfigInsensitive"
          },
          "sensitive": {
            "$ref": "#/components/schemas/CurrentRssUserConfigSensitive"
          }
        },
        "required": [
          "insensitive",
          "sensitive"
        ]
      },
      "CurrentRssUserConfigInsensitive": {
        "description": "The subset of `RackInitializeRequest` that the user fills in as clear text (e.g., via an uploaded config file).",
        "type": "object",
        "properties": {
          "allowed_source_ips": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/AllowedSourceIps"
              }
            ]
          },
          "bootstrap_sleds": {
            "title": "IdOrdMap",
            "x-rust-type": {
              "crate": "iddqd",
              "parameters": [
                {
                  "$ref": "#/components/schemas/BootstrapSledDescription"
                }
              ],
              "path": "iddqd::IdOrdMap",
              "version": "*"
            },
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BootstrapSledDescription"
            },
            "uniqueItems": true
          },
          "dns_servers": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "ip"
            }
          },
          "external_dns_ips": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "ip"
            }
          },
          "external_dns_zone_name": {
            "type": "string"
          },
          "external_jumbo_frames_opt_in_enabled": {
            "description": "Enable the fleet-wide jumbo-frames opt-in. Operators can also toggle this at runtime via the Nexus API after handoff.",
            "default": false,
            "type": "boolean"
          },
          "ntp_servers": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "rack_network_config": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/UserSpecifiedRackNetworkConfig"
              }
            ]
          },
          "service_ip_pools": {
            "title": "IdOrdMap",
            "x-rust-type": {
              "crate": "iddqd",
              "parameters": [
                {
                  "$ref": "#/components/schemas/ServiceIpPoolConfig"
                }
              ],
              "path": "iddqd::IdOrdMap",
              "version": "*"
            },
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceIpPoolConfig"
            },
            "uniqueItems": true
          }
        },
        "required": [
          "bootstrap_sleds",
          "dns_servers",
          "external_dns_ips",
          "external_dns_zone_name",
          "ntp_servers",
          "service_ip_pools"
        ]
      },
      "CurrentRssUserConfigSensitive": {
        "type": "object",
        "properties": {
          "bgp_auth_keys": {
            "$ref": "#/components/schemas/GetBgpAuthKeyInfoResponse"
          },
          "num_external_certificates": {
            "type": "integer",
            "format": "uint",
            "minimum": 0
          },
          "recovery_silo_password_set": {
            "type": "boolean"
          }
        },
        "required": [
          "bgp_auth_keys",
          "num_external_certificates",
          "recovery_silo_password_set"
        ]
      },
      "Datapath": {
        "description": "Information about a transceiver's datapath.\n\nThis includes state related to the low-level eletrical and optical path through which bits flow. This includes flags like loss-of-signal / loss-of-lock; transmitter enablement state; and equalization parameters.",
        "oneOf": [
          {
            "description": "A number of datapaths in a CMIS module.\n\nCMIS modules may have a large number of supported configurations of their various lanes, each called an \"application\". These are described by the `ApplicationDescriptor` type, which mirrors CMIS 5.0 table 8-18. Each descriptor is identified by an \"Application Selector Code\", which is just its index in the section of the memory map describing them.\n\nEach lane can be used in zero or more applications, however, it may exist in at most one application at a time. These active applications, of which there may be more than one, are keyed by their codes in the contained mapping.",
            "type": "object",
            "properties": {
              "cmis": {
                "type": "object",
                "properties": {
                  "connector": {
                    "description": "The type of free-side connector",
                    "type": "string"
                  },
                  "datapaths": {
                    "description": "Mapping from \"application selector\" ID to its datapath information.\n\nThe datapath inclues the lanes used; host electrical interface; media interface; and a lot more about the state of the path.",
                    "type": "object",
                    "additionalProperties": {
                      "$ref": "#/components/schemas/CmisDatapath"
                    }
                  },
                  "supported_lanes": {
                    "description": "A bit mask with a 1 in bit `i` if the `i`th lane is supported.",
                    "type": "integer",
                    "format": "uint8",
                    "minimum": 0
                  }
                },
                "required": [
                  "connector",
                  "datapaths",
                  "supported_lanes"
                ]
              }
            },
            "required": [
              "cmis"
            ],
            "additionalProperties": false
          },
          {
            "description": "Datapath state about each lane in an SFF-8636 module.",
            "type": "object",
            "properties": {
              "sff8636": {
                "type": "object",
                "properties": {
                  "connector": {
                    "description": "The type of a media-side connector.\n\nThese values come from SFF-8024 Rev 4.10 Table 4-3.",
                    "type": "string"
                  },
                  "lanes": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/Sff8636Datapath"
                    },
                    "minItems": 4,
                    "maxItems": 4
                  },
                  "specification": {
                    "$ref": "#/components/schemas/SffComplianceCode"
                  }
                },
                "required": [
                  "connector",
                  "lanes",
                  "specification"
                ]
              }
            },
            "required": [
              "sff8636"
            ],
            "additionalProperties": false
          }
        ]
      },
      "Duration": {
        "type": "object",
        "properties": {
          "nanos": {
            "type": "integer",
            "format": "uint32",
            "minimum": 0
          },
          "secs": {
            "type": "integer",
            "format": "uint64",
            "minimum": 0
          }
        },
        "required": [
          "nanos",
          "secs"
        ]
      },
      "Error": {
        "description": "Error information from a response.",
        "type": "object",
        "properties": {
          "error_code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "request_id": {
            "type": "string"
          }
        },
        "required": [
          "message",
          "request_id"
        ]
      },
      "EventReportForUplinkPreflightCheckSpec": {
        "description": "An oxide-update-engine event report.\n\nRemote reports can be passed into a `StepContext`, in which case they show up as nested events.",
        "type": "object",
        "properties": {
          "last_seen": {
            "nullable": true,
            "description": "The last event seen.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          },
          "progress_events": {
            "description": "A list of progress events, or whether we're currently waiting for a progress event.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProgressEventForUplinkPreflightCheckSpec"
            }
          },
          "root_execution_id": {
            "description": "The root execution ID for this report.",
            "allOf": [
              {
                "nullable": true,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExecutionUuid"
                  }
                ]
              }
            ]
          },
          "step_events": {
            "description": "A list of step events.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StepEventForUplinkPreflightCheckSpec"
            }
          }
        },
        "required": [
          "progress_events",
          "step_events"
        ]
      },
      "EventReportForWicketdEngineSpec": {
        "description": "An oxide-update-engine event report.\n\nRemote reports can be passed into a `StepContext`, in which case they show up as nested events.",
        "type": "object",
        "properties": {
          "last_seen": {
            "nullable": true,
            "description": "The last event seen.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          },
          "progress_events": {
            "description": "A list of progress events, or whether we're currently waiting for a progress event.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProgressEventForWicketdEngineSpec"
            }
          },
          "root_execution_id": {
            "description": "The root execution ID for this report.",
            "allOf": [
              {
                "nullable": true,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExecutionUuid"
                  }
                ]
              }
            ]
          },
          "step_events": {
            "description": "A list of step events.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StepEventForWicketdEngineSpec"
            }
          }
        },
        "required": [
          "progress_events",
          "step_events"
        ]
      },
      "ExecutionUuid": {
        "x-rust-type": {
          "crate": "oxide-update-engine-types",
          "path": "oxide_update_engine_types::events::ExecutionUuid",
          "version": "0.1.2"
        },
        "type": "string",
        "format": "uuid"
      },
      "ExtendedStatus": {
        "type": "integer",
        "format": "uint32",
        "minimum": 0
      },
      "GetArtifactsAndEventReportsResponse": {
        "description": "The response to a `get_artifacts` call: the system version, and the list of all artifacts currently held by wicketd.",
        "type": "object",
        "properties": {
          "artifacts": {
            "description": "List of artifacts we ingested from the most-recently-uploaded TUF repository.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ArtifactId"
            }
          },
          "event_reports": {
            "title": "IdOrdMap",
            "x-rust-type": {
              "crate": "iddqd",
              "parameters": [
                {
                  "$ref": "#/components/schemas/SpEventReport"
                }
              ],
              "path": "iddqd::IdOrdMap",
              "version": "*"
            },
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SpEventReport"
            },
            "uniqueItems": true
          },
          "system_version": {
            "nullable": true,
            "type": "string",
            "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
          }
        },
        "required": [
          "artifacts",
          "event_reports"
        ]
      },
      "GetBaseboardResponse": {
        "type": "object",
        "properties": {
          "baseboard": {
            "$ref": "#/components/schemas/BaseboardId"
          }
        },
        "required": [
          "baseboard"
        ]
      },
      "GetBgpAuthKeyInfoResponse": {
        "description": "Returns information about BGP keys for rack network setup.\n\nThis is part of a wicketd response, but is returned here because our tooling turns BTreeMaps into HashMaps. So we use a `replace` directive instead.",
        "type": "object",
        "properties": {
          "data": {
            "description": "Information about the requested keys.\n\nNone indicates that the key ID has not been set yet. An error indicates that the key was not specified in the rack setup config.",
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/BgpAuthKeyStatus"
            }
          }
        },
        "required": [
          "data"
        ]
      },
      "GetBgpAuthKeyParams": {
        "type": "object",
        "properties": {
          "check_valid": {
            "description": "Checks that these keys are valid.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BgpAuthKeyId"
            },
            "uniqueItems": true
          }
        },
        "required": [
          "check_valid"
        ]
      },
      "GetInventoryParams": {
        "type": "object",
        "properties": {
          "force_refresh": {
            "description": "Refresh the state of these SPs from MGS prior to returning (instead of returning cached data).",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SpIdentifier"
            }
          }
        },
        "required": [
          "force_refresh"
        ]
      },
      "GetInventoryResponse": {
        "description": "The response to a `get_inventory` call: the inventory known to wicketd, or a notification that data is unavailable.",
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "data": {
                "type": "object",
                "properties": {
                  "inventory": {
                    "$ref": "#/components/schemas/RackV1Inventory"
                  }
                },
                "required": [
                  "inventory"
                ]
              },
              "type": {
                "type": "string",
                "enum": [
                  "response"
                ]
              }
            },
            "required": [
              "data",
              "type"
            ]
          },
          {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "unavailable"
                ]
              }
            },
            "required": [
              "type"
            ]
          }
        ]
      },
      "IpNet": {
        "x-rust-type": {
          "crate": "oxnet",
          "path": "oxnet::IpNet",
          "version": "0.1.0"
        },
        "oneOf": [
          {
            "title": "v4",
            "allOf": [
              {
                "$ref": "#/components/schemas/Ipv4Net"
              }
            ]
          },
          {
            "title": "v6",
            "allOf": [
              {
                "$ref": "#/components/schemas/Ipv6Net"
              }
            ]
          }
        ]
      },
      "IpRange": {
        "oneOf": [
          {
            "title": "v4",
            "allOf": [
              {
                "$ref": "#/components/schemas/Ipv4Range"
              }
            ]
          },
          {
            "title": "v6",
            "allOf": [
              {
                "$ref": "#/components/schemas/Ipv6Range"
              }
            ]
          }
        ]
      },
      "Ipv4Net": {
        "example": "192.168.1.0/24",
        "title": "An IPv4 subnet",
        "description": "An IPv4 subnet, including prefix and prefix length",
        "x-rust-type": {
          "crate": "oxnet",
          "path": "oxnet::Ipv4Net",
          "version": "0.1.0"
        },
        "type": "string",
        "pattern": "^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|1[0-9]|2[0-9]|3[0-2])$"
      },
      "Ipv4Range": {
        "description": "A non-decreasing IPv4 address range, inclusive of both ends.\n\nThe first address must be less than or equal to the last address.",
        "type": "object",
        "properties": {
          "first": {
            "type": "string",
            "format": "ipv4"
          },
          "last": {
            "type": "string",
            "format": "ipv4"
          }
        },
        "required": [
          "first",
          "last"
        ]
      },
      "Ipv6Net": {
        "example": "fd12:3456::/64",
        "title": "An IPv6 subnet",
        "description": "An IPv6 subnet, including prefix and subnet mask",
        "x-rust-type": {
          "crate": "oxnet",
          "path": "oxnet::Ipv6Net",
          "version": "0.1.0"
        },
        "type": "string",
        "pattern": "^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\\/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8])$"
      },
      "Ipv6Range": {
        "description": "A non-decreasing IPv6 address range, inclusive of both ends.\n\nThe first address must be less than or equal to the last address.",
        "type": "object",
        "properties": {
          "first": {
            "type": "string",
            "format": "ipv6"
          },
          "last": {
            "type": "string",
            "format": "ipv6"
          }
        },
        "required": [
          "first",
          "last"
        ]
      },
      "LanePolarity": {
        "description": "The polarity of a transceiver lane.",
        "type": "string",
        "enum": [
          "normal",
          "flipped"
        ]
      },
      "LinkFec": {
        "description": "The forward error correction mode of a link.",
        "oneOf": [
          {
            "description": "Firecode forward error correction.",
            "type": "string",
            "enum": [
              "firecode"
            ]
          },
          {
            "description": "No forward error correction.",
            "type": "string",
            "enum": [
              "none"
            ]
          },
          {
            "description": "Reed-Solomon forward error correction.",
            "type": "string",
            "enum": [
              "rs"
            ]
          }
        ]
      },
      "LinkSpeed": {
        "description": "The speed of a link.",
        "oneOf": [
          {
            "description": "Zero gigabits per second.",
            "type": "string",
            "enum": [
              "speed0_g"
            ]
          },
          {
            "description": "1 gigabit per second.",
            "type": "string",
            "enum": [
              "speed1_g"
            ]
          },
          {
            "description": "10 gigabits per second.",
            "type": "string",
            "enum": [
              "speed10_g"
            ]
          },
          {
            "description": "25 gigabits per second.",
            "type": "string",
            "enum": [
              "speed25_g"
            ]
          },
          {
            "description": "40 gigabits per second.",
            "type": "string",
            "enum": [
              "speed40_g"
            ]
          },
          {
            "description": "50 gigabits per second.",
            "type": "string",
            "enum": [
              "speed50_g"
            ]
          },
          {
            "description": "100 gigabits per second.",
            "type": "string",
            "enum": [
              "speed100_g"
            ]
          },
          {
            "description": "200 gigabits per second.",
            "type": "string",
            "enum": [
              "speed200_g"
            ]
          },
          {
            "description": "400 gigabits per second.",
            "type": "string",
            "enum": [
              "speed400_g"
            ]
          }
        ]
      },
      "LldpAdminStatus": {
        "description": "To what extent should this port participate in LLDP",
        "type": "string",
        "enum": [
          "enabled",
          "disabled",
          "rx_only",
          "tx_only"
        ]
      },
      "LldpPortConfig": {
        "description": "Per-port LLDP configuration settings.  Only the \"status\" setting is mandatory.  All other fields have natural defaults or may be inherited from the switch.",
        "type": "object",
        "properties": {
          "chassis_id": {
            "nullable": true,
            "description": "Chassis ID to advertise.  If this is set, it will be advertised as a LocallyAssigned ID type.  If this is not set, it will be inherited from the switch-level settings.",
            "type": "string"
          },
          "management_addrs": {
            "nullable": true,
            "description": "Management IP addresses to advertise.  If this is not set, it will be inherited from the switch-level settings.",
            "type": "array",
            "items": {
              "type": "string",
              "format": "ip"
            }
          },
          "port_description": {
            "nullable": true,
            "description": "Port description to advertise.  If this is not set, no description will be advertised.",
            "type": "string"
          },
          "port_id": {
            "nullable": true,
            "description": "Port ID to advertise.  If this is set, it will be advertised as a LocallyAssigned ID type.  If this is not set, it will be set to the port name. e.g., qsfp0/0.",
            "type": "string"
          },
          "status": {
            "description": "To what extent should this port participate in LLDP",
            "allOf": [
              {
                "$ref": "#/components/schemas/LldpAdminStatus"
              }
            ]
          },
          "system_description": {
            "nullable": true,
            "description": "System description to advertise.  If this is not set, it will be inherited from the switch-level settings.",
            "type": "string"
          },
          "system_name": {
            "nullable": true,
            "description": "System name to advertise.  If this is not set, it will be inherited from the switch-level settings.",
            "type": "string"
          }
        },
        "required": [
          "status"
        ]
      },
      "MaxPathConfig": {
        "type": "integer",
        "format": "uint8",
        "minimum": 1,
        "maximum": 32
      },
      "MediaInterfaceId": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "description": "Media interface ID for multi-mode fiber media.\n\nSee SFF-8024 Table 4-6.",
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "mmf"
                ]
              }
            },
            "required": [
              "id",
              "type"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "description": "Media interface ID for single-mode fiber.\n\nSee SFF-8024 Table 4-7.",
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "smf"
                ]
              }
            },
            "required": [
              "id",
              "type"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "description": "Media interface ID for passive copper cables.\n\nSee SFF-8024 Table 4-8.",
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "passive_copper"
                ]
              }
            },
            "required": [
              "id",
              "type"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "description": "Media interface ID for active cable assemblies.\n\nSee SFF-8024 Table 4-9.",
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "active_cable"
                ]
              }
            },
            "required": [
              "id",
              "type"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "description": "Media interface ID for BASE-T.\n\nSee SFF-8024 Table 4-10.",
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "base_t"
                ]
              }
            },
            "required": [
              "id",
              "type"
            ]
          }
        ]
      },
      "MgsV1Inventory": {
        "description": "The current state of the v1 Rack as known to MGS",
        "type": "object",
        "properties": {
          "sps": {
            "title": "IdOrdMap",
            "x-rust-type": {
              "crate": "iddqd",
              "parameters": [
                {
                  "$ref": "#/components/schemas/SpInventory"
                }
              ],
              "path": "iddqd::IdOrdMap",
              "version": "*"
            },
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SpInventory"
            },
            "uniqueItems": true
          }
        },
        "required": [
          "sps"
        ]
      },
      "MgsV1InventorySnapshot": {
        "description": "The state of the v1 Rack as known to MGS at a given time.",
        "type": "object",
        "properties": {
          "inventory": {
            "$ref": "#/components/schemas/MgsV1Inventory"
          },
          "last_seen": {
            "$ref": "#/components/schemas/Duration"
          }
        },
        "required": [
          "inventory",
          "last_seen"
        ]
      },
      "Monitors": {
        "description": "Free-side device monitoring information.\n\nNote that all values are optional, as some specifications do not require that modules implement monitoring of those values.",
        "type": "object",
        "properties": {
          "aux_monitors": {
            "nullable": true,
            "description": "Auxiliary monitoring values.\n\nThese are only available on CMIS-compatible transceivers, e.g., QSFP-DD.",
            "allOf": [
              {
                "$ref": "#/components/schemas/AuxMonitors"
              }
            ]
          },
          "receiver_power": {
            "nullable": true,
            "description": "The measured input optical power (milliwatts);\n\nNote that due to a limitation in the SFF-8636 specification, it's possible for receiver power to be zero. See [`ReceiverPower`] for details.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReceiverPower"
            }
          },
          "supply_voltage": {
            "nullable": true,
            "description": "The measured input supply voltage (Volts).",
            "type": "number",
            "format": "float"
          },
          "temperature": {
            "nullable": true,
            "description": "The measured cage temperature (degrees C);",
            "type": "number",
            "format": "float"
          },
          "transmitter_bias_current": {
            "nullable": true,
            "description": "The output laser bias current (milliamps).",
            "type": "array",
            "items": {
              "type": "number",
              "format": "float"
            }
          },
          "transmitter_power": {
            "nullable": true,
            "description": "The measured output optical power (milliwatts).",
            "type": "array",
            "items": {
              "type": "number",
              "format": "float"
            }
          }
        }
      },
      "MultirackJoinConfigBaseUserInput": {
        "description": "Input from a user for adopting an uninitialized rack into an existing regional cluster.\n\nThis type is provided in the form of a TOML file uploaded via the wicket CLI. It does not contain sensitive user input such as BGP keys. Those are input separately.",
        "type": "object",
        "properties": {
          "bootstrap_slots": {
            "description": "List of slot numbers only.",
            "type": "array",
            "items": {
              "type": "integer",
              "format": "uint16",
              "minimum": 0
            },
            "uniqueItems": true
          },
          "rack_network_config": {
            "$ref": "#/components/schemas/UserSpecifiedRackNetworkConfig"
          }
        },
        "required": [
          "bootstrap_slots",
          "rack_network_config"
        ]
      },
      "MultirackJoinUuid": {
        "x-rust-type": {
          "crate": "omicron-uuid-kinds",
          "path": "omicron_uuid_kinds::MultirackJoinUuid",
          "version": "*"
        },
        "type": "string",
        "format": "uuid"
      },
      "Name": {
        "title": "A name unique within the parent collection",
        "description": "Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID, but they may contain a UUID. They can be at most 63 characters long.",
        "type": "string",
        "pattern": "^(?![0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)^[a-z]([a-zA-Z0-9-]*[a-zA-Z0-9]+)?$",
        "minLength": 1,
        "maxLength": 63
      },
      "Oui": {
        "description": "An Organization Unique Identifier.",
        "type": "array",
        "items": {
          "type": "integer",
          "format": "uint8",
          "minimum": 0
        },
        "minItems": 3,
        "maxItems": 3
      },
      "OutputStatus": {
        "type": "string",
        "enum": [
          "valid",
          "invalid"
        ]
      },
      "PowerMode": {
        "description": "The power mode of a module.",
        "type": "object",
        "properties": {
          "software_override": {
            "nullable": true,
            "description": "Whether the module is configured for software override of power control.\n\nIf the module is in `PowerState::Off`, this can't be determined, and `None` is returned.",
            "type": "boolean"
          },
          "state": {
            "description": "The actual power state.",
            "allOf": [
              {
                "$ref": "#/components/schemas/PowerState3"
              }
            ]
          }
        },
        "required": [
          "state"
        ]
      },
      "PowerState": {
        "description": "See RFD 81.\n\nThis enum only lists power states the SP is able to control; higher power states are controlled by ignition.",
        "type": "string",
        "enum": [
          "A0",
          "A1",
          "A2"
        ]
      },
      "PowerState2": {
        "description": "See RFD 81.\n\nThis enum only lists power states the SP is able to control; higher power states are controlled by ignition.",
        "type": "string",
        "enum": [
          "A0",
          "A1",
          "A2"
        ]
      },
      "PowerState3": {
        "description": "An allowed power state for the module.",
        "oneOf": [
          {
            "description": "A module is entirely powered off, using the EFuse.",
            "type": "string",
            "enum": [
              "off"
            ]
          },
          {
            "description": "Power is enabled to the module, but module remains in low-power mode.\n\nIn this state, modules will not establish a link or transmit traffic, but they may be managed and queried for information through their memory maps.",
            "type": "string",
            "enum": [
              "low"
            ]
          },
          {
            "description": "The module is in high-power mode.\n\nNote that additional configuration may be required to correctly configure the module, such as described in SFF-8636 rev 2.10a table 6-10, and that the _host side_ is responsible for ensuring that the relevant configuration is applied.",
            "type": "string",
            "enum": [
              "high"
            ]
          }
        ]
      },
      "PreflightUplinkCheckOptions": {
        "description": "Options provided to the preflight uplink check.",
        "type": "object",
        "properties": {
          "dns_name_to_query": {
            "nullable": true,
            "description": "DNS name to query.",
            "type": "string"
          }
        }
      },
      "ProgressCounter": {
        "description": "Current progress.",
        "x-rust-type": {
          "crate": "oxide-update-engine-types",
          "path": "oxide_update_engine_types::events::ProgressCounter",
          "version": "0.1.2"
        },
        "type": "object",
        "properties": {
          "current": {
            "description": "The current progress.",
            "type": "integer",
            "format": "uint64",
            "minimum": 0
          },
          "total": {
            "nullable": true,
            "description": "The total progress.",
            "type": "integer",
            "format": "uint64",
            "minimum": 0
          },
          "units": {
            "description": "Progress units.",
            "allOf": [
              {
                "$ref": "#/components/schemas/ProgressUnits"
              }
            ]
          }
        },
        "required": [
          "current",
          "units"
        ]
      },
      "ProgressEventForGenericSpec": {
        "x-rust-type": {
          "crate": "oxide-update-engine-types",
          "parameters": [
            {
              "x-rust-type": {
                "crate": "oxide-update-engine-types",
                "path": "oxide_update_engine_types::spec::GenericSpec",
                "version": "0.1.2"
              }
            }
          ],
          "path": "oxide_update_engine_types::events::ProgressEvent",
          "version": "0.1.2"
        },
        "type": "object",
        "properties": {
          "data": {
            "description": "The kind of event this is.",
            "allOf": [
              {
                "$ref": "#/components/schemas/ProgressEventKindForGenericSpec"
              }
            ]
          },
          "execution_id": {
            "description": "The execution ID.",
            "allOf": [
              {
                "$ref": "#/components/schemas/ExecutionUuid"
              }
            ]
          },
          "spec": {
            "description": "The specification that this event belongs to.",
            "type": "string"
          },
          "total_elapsed": {
            "description": "Total time elapsed since the start of execution.",
            "allOf": [
              {
                "$ref": "#/components/schemas/Duration"
              }
            ]
          }
        },
        "required": [
          "data",
          "execution_id",
          "spec",
          "total_elapsed"
        ]
      },
      "ProgressEventForUplinkPreflightCheckSpec": {
        "type": "object",
        "properties": {
          "data": {
            "description": "The kind of event this is.",
            "allOf": [
              {
                "$ref": "#/components/schemas/ProgressEventKindForUplinkPreflightCheckSpec"
              }
            ]
          },
          "execution_id": {
            "description": "The execution ID.",
            "allOf": [
              {
                "$ref": "#/components/schemas/ExecutionUuid"
              }
            ]
          },
          "spec": {
            "description": "The specification that this event belongs to.",
            "type": "string"
          },
          "total_elapsed": {
            "description": "Total time elapsed since the start of execution.",
            "allOf": [
              {
                "$ref": "#/components/schemas/Duration"
              }
            ]
          }
        },
        "required": [
          "data",
          "execution_id",
          "spec",
          "total_elapsed"
        ]
      },
      "ProgressEventForWicketdEngineSpec": {
        "type": "object",
        "properties": {
          "data": {
            "description": "The kind of event this is.",
            "allOf": [
              {
                "$ref": "#/components/schemas/ProgressEventKindForWicketdEngineSpec"
              }
            ]
          },
          "execution_id": {
            "description": "The execution ID.",
            "allOf": [
              {
                "$ref": "#/components/schemas/ExecutionUuid"
              }
            ]
          },
          "spec": {
            "description": "The specification that this event belongs to.",
            "type": "string"
          },
          "total_elapsed": {
            "description": "Total time elapsed since the start of execution.",
            "allOf": [
              {
                "$ref": "#/components/schemas/Duration"
              }
            ]
          }
        },
        "required": [
          "data",
          "execution_id",
          "spec",
          "total_elapsed"
        ]
      },
      "ProgressEventKindForGenericSpec": {
        "oneOf": [
          {
            "description": "The update engine is waiting for a progress message.\n\nThe update engine sends this message immediately after a [`StepEvent`] corresponding to a new step.",
            "type": "object",
            "properties": {
              "attempt": {
                "description": "The attempt number currently being executed.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "Total time elapsed since the start of the attempt.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "waiting_for_progress"
                ]
              },
              "step": {
                "description": "Information about the step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForGenericSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt",
              "attempt_elapsed",
              "kind",
              "step",
              "step_elapsed"
            ]
          },
          {
            "type": "object",
            "properties": {
              "attempt": {
                "description": "The attempt number currently being executed.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "Total time elapsed since the start of the attempt.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "progress"
                ]
              },
              "metadata": {
                "description": "Metadata that was returned with progress."
              },
              "progress": {
                "nullable": true,
                "description": "Current progress.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ProgressCounter"
                  }
                ]
              },
              "step": {
                "description": "Information about the step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForGenericSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt",
              "attempt_elapsed",
              "kind",
              "metadata",
              "step",
              "step_elapsed"
            ]
          },
          {
            "type": "object",
            "properties": {
              "attempt": {
                "description": "The attempt number currently being executed.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "The time it took for this attempt to complete.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "event": {
                "description": "The event that occurred.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ProgressEventForGenericSpec"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "nested"
                ]
              },
              "step": {
                "description": "Information about the step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForGenericSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt",
              "attempt_elapsed",
              "event",
              "kind",
              "step",
              "step_elapsed"
            ]
          },
          {
            "description": "Future variants that might be unknown.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "unknown"
                ]
              }
            },
            "required": [
              "kind"
            ]
          }
        ]
      },
      "ProgressEventKindForUplinkPreflightCheckSpec": {
        "oneOf": [
          {
            "description": "The update engine is waiting for a progress message.\n\nThe update engine sends this message immediately after a [`StepEvent`] corresponding to a new step.",
            "type": "object",
            "properties": {
              "attempt": {
                "description": "The attempt number currently being executed.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "Total time elapsed since the start of the attempt.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "waiting_for_progress"
                ]
              },
              "step": {
                "description": "Information about the step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForUplinkPreflightCheckSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt",
              "attempt_elapsed",
              "kind",
              "step",
              "step_elapsed"
            ]
          },
          {
            "type": "object",
            "properties": {
              "attempt": {
                "description": "The attempt number currently being executed.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "Total time elapsed since the start of the attempt.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "progress"
                ]
              },
              "metadata": {
                "description": "Metadata that was returned with progress.",
                "type": "string"
              },
              "progress": {
                "nullable": true,
                "description": "Current progress.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ProgressCounter"
                  }
                ]
              },
              "step": {
                "description": "Information about the step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForUplinkPreflightCheckSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt",
              "attempt_elapsed",
              "kind",
              "metadata",
              "step",
              "step_elapsed"
            ]
          },
          {
            "type": "object",
            "properties": {
              "attempt": {
                "description": "The attempt number currently being executed.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "The time it took for this attempt to complete.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "event": {
                "description": "The event that occurred.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ProgressEventForGenericSpec"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "nested"
                ]
              },
              "step": {
                "description": "Information about the step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForUplinkPreflightCheckSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt",
              "attempt_elapsed",
              "event",
              "kind",
              "step",
              "step_elapsed"
            ]
          },
          {
            "description": "Future variants that might be unknown.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "unknown"
                ]
              }
            },
            "required": [
              "kind"
            ]
          }
        ]
      },
      "ProgressEventKindForWicketdEngineSpec": {
        "oneOf": [
          {
            "description": "The update engine is waiting for a progress message.\n\nThe update engine sends this message immediately after a [`StepEvent`] corresponding to a new step.",
            "type": "object",
            "properties": {
              "attempt": {
                "description": "The attempt number currently being executed.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "Total time elapsed since the start of the attempt.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "waiting_for_progress"
                ]
              },
              "step": {
                "description": "Information about the step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForWicketdEngineSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt",
              "attempt_elapsed",
              "kind",
              "step",
              "step_elapsed"
            ]
          },
          {
            "type": "object",
            "properties": {
              "attempt": {
                "description": "The attempt number currently being executed.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "Total time elapsed since the start of the attempt.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "progress"
                ]
              },
              "metadata": {
                "description": "Metadata that was returned with progress."
              },
              "progress": {
                "nullable": true,
                "description": "Current progress.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ProgressCounter"
                  }
                ]
              },
              "step": {
                "description": "Information about the step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForWicketdEngineSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt",
              "attempt_elapsed",
              "kind",
              "metadata",
              "step",
              "step_elapsed"
            ]
          },
          {
            "type": "object",
            "properties": {
              "attempt": {
                "description": "The attempt number currently being executed.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "The time it took for this attempt to complete.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "event": {
                "description": "The event that occurred.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ProgressEventForGenericSpec"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "nested"
                ]
              },
              "step": {
                "description": "Information about the step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForWicketdEngineSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt",
              "attempt_elapsed",
              "event",
              "kind",
              "step",
              "step_elapsed"
            ]
          },
          {
            "description": "Future variants that might be unknown.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "unknown"
                ]
              }
            },
            "required": [
              "kind"
            ]
          }
        ]
      },
      "ProgressUnits": {
        "x-rust-type": {
          "crate": "oxide-update-engine-types",
          "path": "oxide_update_engine_types::events::ProgressUnits",
          "version": "0.1.2"
        },
        "type": "string"
      },
      "RackInitUuid": {
        "x-rust-type": {
          "crate": "omicron-uuid-kinds",
          "path": "omicron_uuid_kinds::RackInitUuid",
          "version": "*"
        },
        "type": "string",
        "format": "uuid"
      },
      "RackOperationStatus": {
        "description": "Current status of any rack-level operation being performed by this bootstrap agent.",
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "uninitialized"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "$ref": "#/components/schemas/RackInitUuid"
              },
              "status": {
                "type": "string",
                "enum": [
                  "initializing"
                ]
              },
              "step": {
                "$ref": "#/components/schemas/RssStep"
              }
            },
            "required": [
              "id",
              "status",
              "step"
            ]
          },
          {
            "description": "`id` will be none if the rack was already initialized on startup.",
            "type": "object",
            "properties": {
              "id": {
                "nullable": true,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/RackInitUuid"
                  }
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "initialized"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "$ref": "#/components/schemas/RackInitUuid"
              },
              "message": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "initialization_failed"
                ]
              }
            },
            "required": [
              "id",
              "message",
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "$ref": "#/components/schemas/RackInitUuid"
              },
              "status": {
                "type": "string",
                "enum": [
                  "initialization_panicked"
                ]
              }
            },
            "required": [
              "id",
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "$ref": "#/components/schemas/MultirackJoinUuid"
              },
              "status": {
                "type": "string",
                "enum": [
                  "multirack_join_in_progress"
                ]
              }
            },
            "required": [
              "id",
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "nullable": true,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MultirackJoinUuid"
                  }
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "multirack_join_completed"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "$ref": "#/components/schemas/MultirackJoinUuid"
              },
              "message": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "multirack_join_failed"
                ]
              }
            },
            "required": [
              "id",
              "message",
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "$ref": "#/components/schemas/MultirackJoinUuid"
              },
              "status": {
                "type": "string",
                "enum": [
                  "multirack_join_panicked"
                ]
              }
            },
            "required": [
              "id",
              "status"
            ]
          }
        ]
      },
      "RackV1Inventory": {
        "description": "The current state of the v1 Rack as known to wicketd",
        "type": "object",
        "properties": {
          "mgs": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/MgsV1InventorySnapshot"
              }
            ]
          },
          "transceivers": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/TransceiverInventorySnapshot"
              }
            ]
          }
        }
      },
      "ReceiverPower": {
        "description": "Measured receiver optical power.\n\nThe SFF specifications allow for devices to monitor input optical power in several ways. It may either be an average power, over some unspecified time, or a peak-to-peak power. The latter is often abbreviated OMA, for Optical Modulation Amplitude. Again the time interval for peak-to-peak measurments are not specified.\n\nDetails -------\n\nThe SFF-8636 specification has an unfortunate limitation. There is no separate advertisement for whether a module supports measurements of receiver power. Instead, the _kind_ of measurement is advertised. The _same bit value_ could mean that either a peak-to-peak measurement is supported, or the measurements are not supported at all. Thus values of `PeakToPeak(0.0)` may mean that power measurements are not supported.",
        "oneOf": [
          {
            "description": "The measurement is represents average optical power, in mW.",
            "type": "object",
            "properties": {
              "average": {
                "type": "number",
                "format": "float"
              }
            },
            "required": [
              "average"
            ],
            "additionalProperties": false
          },
          {
            "description": "The measurement represents a peak-to-peak, in mW.",
            "type": "object",
            "properties": {
              "peak_to_peak": {
                "type": "number",
                "format": "float"
              }
            },
            "required": [
              "peak_to_peak"
            ],
            "additionalProperties": false
          }
        ]
      },
      "RotImageError": {
        "type": "string",
        "enum": [
          "unchecked",
          "first_page_erased",
          "partially_programmed",
          "invalid_length",
          "header_not_programmed",
          "bootloader_too_small",
          "bad_magic",
          "header_image_size",
          "unaligned_length",
          "unsupported_type",
          "reset_vector_not_thumb2",
          "reset_vector",
          "signature"
        ]
      },
      "RotInventory": {
        "description": "RoT-related data that isn't already supplied in [`SpState`].",
        "type": "object",
        "properties": {
          "active": {
            "$ref": "#/components/schemas/RotSlot"
          },
          "caboose_a": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/SpComponentCaboose"
              }
            ]
          },
          "caboose_b": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/SpComponentCaboose"
              }
            ]
          },
          "caboose_stage0": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/SpComponentCaboose"
              }
            ]
          },
          "caboose_stage0next": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/SpComponentCaboose"
              }
            ]
          }
        },
        "required": [
          "active"
        ]
      },
      "RotSlot": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "slot": {
                "type": "string",
                "enum": [
                  "a"
                ]
              }
            },
            "required": [
              "slot"
            ]
          },
          {
            "type": "object",
            "properties": {
              "slot": {
                "type": "string",
                "enum": [
                  "b"
                ]
              }
            },
            "required": [
              "slot"
            ]
          }
        ]
      },
      "RotState": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "active": {
                "$ref": "#/components/schemas/RotSlot"
              },
              "pending_persistent_boot_preference": {
                "nullable": true,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/RotSlot"
                  }
                ]
              },
              "persistent_boot_preference": {
                "$ref": "#/components/schemas/RotSlot"
              },
              "slot_a_sha3_256_digest": {
                "nullable": true,
                "type": "string"
              },
              "slot_b_sha3_256_digest": {
                "nullable": true,
                "type": "string"
              },
              "state": {
                "type": "string",
                "enum": [
                  "v2"
                ]
              },
              "transient_boot_preference": {
                "nullable": true,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/RotSlot"
                  }
                ]
              }
            },
            "required": [
              "active",
              "persistent_boot_preference",
              "state"
            ]
          },
          {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "state": {
                "type": "string",
                "enum": [
                  "communication_failed"
                ]
              }
            },
            "required": [
              "message",
              "state"
            ]
          },
          {
            "type": "object",
            "properties": {
              "active": {
                "$ref": "#/components/schemas/RotSlot"
              },
              "pending_persistent_boot_preference": {
                "nullable": true,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/RotSlot"
                  }
                ]
              },
              "persistent_boot_preference": {
                "$ref": "#/components/schemas/RotSlot"
              },
              "slot_a_error": {
                "nullable": true,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/RotImageError"
                  }
                ]
              },
              "slot_a_fwid": {
                "type": "string"
              },
              "slot_b_error": {
                "nullable": true,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/RotImageError"
                  }
                ]
              },
              "slot_b_fwid": {
                "type": "string"
              },
              "stage0_error": {
                "nullable": true,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/RotImageError"
                  }
                ]
              },
              "stage0_fwid": {
                "type": "string"
              },
              "stage0next_error": {
                "nullable": true,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/RotImageError"
                  }
                ]
              },
              "stage0next_fwid": {
                "type": "string"
              },
              "state": {
                "type": "string",
                "enum": [
                  "v3"
                ]
              },
              "transient_boot_preference": {
                "nullable": true,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/RotSlot"
                  }
                ]
              }
            },
            "required": [
              "active",
              "persistent_boot_preference",
              "slot_a_fwid",
              "slot_b_fwid",
              "stage0_fwid",
              "stage0next_fwid",
              "state"
            ]
          }
        ]
      },
      "RouteConfig": {
        "type": "object",
        "properties": {
          "destination": {
            "description": "The destination of the route.",
            "allOf": [
              {
                "$ref": "#/components/schemas/IpNet"
              }
            ]
          },
          "nexthop": {
            "description": "The nexthop/gateway address.",
            "type": "string",
            "format": "ip"
          },
          "rib_priority": {
            "nullable": true,
            "description": "The RIB priority (i.e. Admin Distance) associated with this route.",
            "default": null,
            "type": "integer",
            "format": "uint8",
            "minimum": 0
          },
          "vlan_id": {
            "nullable": true,
            "description": "The VLAN id associated with this route.",
            "default": null,
            "type": "integer",
            "format": "uint16",
            "minimum": 0
          }
        },
        "required": [
          "destination",
          "nexthop"
        ]
      },
      "RouterLifetimeConfig": {
        "description": "Router lifetime in seconds for unnumbered BGP peers",
        "type": "integer",
        "format": "uint16",
        "minimum": 0,
        "maximum": 9000
      },
      "RssStep": {
        "description": "Steps we go through during initial rack setup. Keep this list in order that they happen.",
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "requested"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "starting"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "load_existing_plan"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "create_sled_plan"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "init_trust_quorum"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "initial_network_config_update"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "sled_init"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "final_network_config_update"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "init_dns"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "configure_dns"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "init_ntp"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "wait_for_time_sync"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "wait_for_database"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "cluster_init"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "zones_init"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "nexus_handoff"
                ]
              }
            },
            "required": [
              "status"
            ]
          }
        ]
      },
      "ServiceIpPoolConfig": {
        "description": "Full details of a system-service IP pool, provided at rack setup (RSS).",
        "type": "object",
        "properties": {
          "description": {
            "description": "Description of the IP Pool",
            "type": "string"
          },
          "name": {
            "description": "Name of the IP Pool",
            "allOf": [
              {
                "$ref": "#/components/schemas/Name"
              }
            ]
          },
          "ranges": {
            "description": "List of IP address ranges in the pool.\n\nThere is guaranteed to be at least one range, and all ranges are of the same IP version.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IpRange"
            }
          }
        },
        "required": [
          "description",
          "name",
          "ranges"
        ]
      },
      "Sff8636Datapath": {
        "description": "The datapath of an SFF-8636 module.\n\nThis describes the state of a single lane in an SFF module. It includes information about input and output signals, faults, and controls.",
        "type": "object",
        "properties": {
          "rx_cdr_enabled": {
            "description": "Media-side transmit Clock and Data Recovery (CDR) enable status.\n\nCDR is the process by which the module enages an internal retimer function, through which the module attempts to recovery a clock signal directly from the input bitstream.",
            "type": "boolean"
          },
          "rx_lol": {
            "description": "Media-side loss of lock flag.\n\nThis is true if the module is not able to extract a clock signal from the media-side signal (usually optical).",
            "type": "boolean"
          },
          "rx_los": {
            "description": "Media-side loss of signal flag.\n\nThis is true if there is no detected input signal from the media-side (usually optical).",
            "type": "boolean"
          },
          "tx_adaptive_eq_fault": {
            "description": "Flag indicating a fault in adaptive transmit equalization.",
            "type": "boolean"
          },
          "tx_cdr_enabled": {
            "description": "Host-side transmit Clock and Data Recovery (CDR) enable status.\n\nCDR is the process by which the module enages an internal retimer function, through which the module attempts to recovery a clock signal directly from the input bitstream.",
            "type": "boolean"
          },
          "tx_enabled": {
            "description": "Software control of output transmitter.",
            "type": "boolean"
          },
          "tx_fault": {
            "description": "Flag indicating a fault in the transmitter and/or laser.",
            "type": "boolean"
          },
          "tx_lol": {
            "description": "Host-side loss of lock flag.\n\nThis is true if the module is not able to extract a clock signal from the host-side electrical signal.",
            "type": "boolean"
          },
          "tx_los": {
            "description": "Host-side loss of signal flag.\n\nThis is true if there is no detected electrical signal from the host-side serdes.",
            "type": "boolean"
          }
        },
        "required": [
          "rx_cdr_enabled",
          "rx_lol",
          "rx_los",
          "tx_adaptive_eq_fault",
          "tx_cdr_enabled",
          "tx_enabled",
          "tx_fault",
          "tx_lol",
          "tx_los"
        ]
      },
      "SffComplianceCode": {
        "description": "The compliance code for an SFF-8636 module.\n\nThese values record a specification compliance code, from SFF-8636 Table 6-17, or an extended specification compliance code, from SFF-8024 Table 4-4.",
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "code": {
                "description": "Extended electrical or optical interface codes",
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "extended"
                ]
              }
            },
            "required": [
              "code",
              "type"
            ]
          },
          {
            "type": "object",
            "properties": {
              "code": {
                "description": "The Ethernet specification implemented by a module.",
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "ethernet"
                ]
              }
            },
            "required": [
              "code",
              "type"
            ]
          }
        ]
      },
      "SpComponentCaboose": {
        "description": "`SpComponentCaboose`",
        "type": "object",
        "properties": {
          "board": {
            "type": "string"
          },
          "epoch": {
            "nullable": true,
            "type": "string"
          },
          "git_commit": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "sign": {
            "nullable": true,
            "type": "string"
          },
          "version": {
            "type": "string"
          }
        },
        "required": [
          "board",
          "git_commit",
          "name",
          "version"
        ]
      },
      "SpComponentInfo": {
        "description": "Overview of a single SP component.",
        "type": "object",
        "properties": {
          "capabilities": {
            "description": "`capabilities` is a bitmask; interpret it via [`gateway_messages::DeviceCapabilities`].",
            "type": "integer",
            "format": "uint32",
            "minimum": 0
          },
          "component": {
            "description": "The unique identifier for this component.",
            "type": "string"
          },
          "description": {
            "description": "A human-readable description of the component.",
            "type": "string"
          },
          "device": {
            "description": "The name of the physical device.",
            "type": "string"
          },
          "presence": {
            "description": "Whether or not the component is present, to the best of the SP's ability to judge.",
            "allOf": [
              {
                "$ref": "#/components/schemas/SpComponentPresence"
              }
            ]
          },
          "serial_number": {
            "nullable": true,
            "description": "The component's serial number, if it has one.",
            "type": "string"
          }
        },
        "required": [
          "capabilities",
          "component",
          "description",
          "device",
          "presence"
        ]
      },
      "SpComponentPresence": {
        "description": "Description of the presence or absence of a component.\n\nThe presence of some components may vary based on the power state of the sled (e.g., components that time out or appear unavailable if the sled is in A2 may become present when the sled moves to A0).",
        "oneOf": [
          {
            "description": "The component is present.",
            "type": "string",
            "enum": [
              "present"
            ]
          },
          {
            "description": "The component is not present.",
            "type": "string",
            "enum": [
              "not_present"
            ]
          },
          {
            "description": "The component is present but in a failed or faulty state.",
            "type": "string",
            "enum": [
              "failed"
            ]
          },
          {
            "description": "The SP is unable to determine the presence of the component.",
            "type": "string",
            "enum": [
              "unavailable"
            ]
          },
          {
            "description": "The SP's attempt to determine the presence of the component timed out.",
            "type": "string",
            "enum": [
              "timeout"
            ]
          },
          {
            "description": "The SP's attempt to determine the presence of the component failed.",
            "type": "string",
            "enum": [
              "error"
            ]
          }
        ]
      },
      "SpEventReport": {
        "description": "An event report for a single SP.",
        "type": "object",
        "properties": {
          "event_report": {
            "$ref": "#/components/schemas/EventReportForWicketdEngineSpec"
          },
          "sp": {
            "$ref": "#/components/schemas/SpIdentifier"
          }
        },
        "required": [
          "event_report",
          "sp"
        ]
      },
      "SpIdentifier": {
        "type": "object",
        "properties": {
          "slot": {
            "type": "integer",
            "format": "uint16",
            "minimum": 0
          },
          "type": {
            "$ref": "#/components/schemas/SpType"
          }
        },
        "required": [
          "slot",
          "type"
        ]
      },
      "SpIgnition": {
        "description": "State of an ignition target.",
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "present": {
                "type": "string",
                "enum": [
                  "no"
                ]
              }
            },
            "required": [
              "present"
            ]
          },
          {
            "type": "object",
            "properties": {
              "ctrl_detect_0": {
                "type": "boolean"
              },
              "ctrl_detect_1": {
                "type": "boolean"
              },
              "flt_a2": {
                "description": "Fault from the A2 power domain",
                "type": "boolean"
              },
              "flt_a3": {
                "description": "Fault from the A3 power domain",
                "type": "boolean"
              },
              "flt_rot": {
                "description": "Fault from the RoT",
                "type": "boolean"
              },
              "flt_sp": {
                "description": "Fault from the SP",
                "type": "boolean"
              },
              "id": {
                "$ref": "#/components/schemas/SpIgnitionSystemType"
              },
              "power": {
                "type": "boolean"
              },
              "present": {
                "type": "string",
                "enum": [
                  "yes"
                ]
              }
            },
            "required": [
              "ctrl_detect_0",
              "ctrl_detect_1",
              "flt_a2",
              "flt_a3",
              "flt_rot",
              "flt_sp",
              "id",
              "power",
              "present"
            ]
          }
        ]
      },
      "SpIgnitionSystemType": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "system_type": {
                "type": "string",
                "enum": [
                  "gimlet"
                ]
              }
            },
            "required": [
              "system_type"
            ]
          },
          {
            "type": "object",
            "properties": {
              "system_type": {
                "type": "string",
                "enum": [
                  "sidecar"
                ]
              }
            },
            "required": [
              "system_type"
            ]
          },
          {
            "type": "object",
            "properties": {
              "system_type": {
                "type": "string",
                "enum": [
                  "psc"
                ]
              }
            },
            "required": [
              "system_type"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "format": "uint16",
                "minimum": 0
              },
              "system_type": {
                "type": "string",
                "enum": [
                  "unknown"
                ]
              }
            },
            "required": [
              "id",
              "system_type"
            ]
          },
          {
            "type": "object",
            "properties": {
              "system_type": {
                "type": "string",
                "enum": [
                  "cosmo"
                ]
              }
            },
            "required": [
              "system_type"
            ]
          }
        ]
      },
      "SpInventory": {
        "description": "SP-related data",
        "type": "object",
        "properties": {
          "caboose_active": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/SpComponentCaboose"
              }
            ]
          },
          "caboose_inactive": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/SpComponentCaboose"
              }
            ]
          },
          "components": {
            "nullable": true,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SpComponentInfo"
            }
          },
          "id": {
            "$ref": "#/components/schemas/SpIdentifier"
          },
          "ignition": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/SpIgnition"
              }
            ]
          },
          "rot": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/RotInventory"
              }
            ]
          },
          "state": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/SpState"
              }
            ]
          }
        },
        "required": [
          "id"
        ]
      },
      "SpState": {
        "type": "object",
        "properties": {
          "base_mac_address": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "uint8",
              "minimum": 0
            },
            "minItems": 6,
            "maxItems": 6
          },
          "hubris_archive_id": {
            "type": "string"
          },
          "model": {
            "type": "string"
          },
          "power_state": {
            "$ref": "#/components/schemas/PowerState2"
          },
          "revision": {
            "type": "integer",
            "format": "uint32",
            "minimum": 0
          },
          "rot": {
            "$ref": "#/components/schemas/RotState"
          },
          "serial_number": {
            "type": "string"
          }
        },
        "required": [
          "base_mac_address",
          "hubris_archive_id",
          "model",
          "power_state",
          "revision",
          "rot",
          "serial_number"
        ]
      },
      "SpType": {
        "type": "string",
        "enum": [
          "sled",
          "power",
          "switch"
        ]
      },
      "StartUpdateOptions": {
        "type": "object",
        "properties": {
          "skip_rot_bootloader_version_check": {
            "description": "If true, skip the check on the current RoT version and always update it regardless of whether the update appears to be neeeded.",
            "type": "boolean"
          },
          "skip_rot_version_check": {
            "description": "If true, skip the check on the current RoT version and always update it regardless of whether the update appears to be neeeded.",
            "type": "boolean"
          },
          "skip_sp_version_check": {
            "description": "If true, skip the check on the current SP version and always update it regardless of whether the update appears to be neeeded.",
            "type": "boolean"
          },
          "test_error": {
            "nullable": true,
            "description": "If passed in, fails the update with a simulated error.",
            "allOf": [
              {
                "$ref": "#/components/schemas/UpdateTestError"
              }
            ]
          },
          "test_simulate_rot_bootloader_result": {
            "nullable": true,
            "description": "If passed in, simulates a result for the RoT Bootloader update.\n\nThis is used for testing.",
            "allOf": [
              {
                "$ref": "#/components/schemas/UpdateSimulatedResult"
              }
            ]
          },
          "test_simulate_rot_result": {
            "nullable": true,
            "description": "If passed in, simulates a result for the RoT update.\n\nThis is used for testing.",
            "allOf": [
              {
                "$ref": "#/components/schemas/UpdateSimulatedResult"
              }
            ]
          },
          "test_simulate_sp_result": {
            "nullable": true,
            "description": "If passed in, simulates a result for the SP update.\n\nThis is used for testing.",
            "allOf": [
              {
                "$ref": "#/components/schemas/UpdateSimulatedResult"
              }
            ]
          },
          "test_step_seconds": {
            "nullable": true,
            "description": "If passed in, creates a test step that lasts these many seconds long.\n\nThis is used for testing.",
            "type": "integer",
            "format": "uint64",
            "minimum": 0
          }
        },
        "required": [
          "skip_rot_bootloader_version_check",
          "skip_rot_version_check",
          "skip_sp_version_check"
        ]
      },
      "StartUpdateParams": {
        "type": "object",
        "properties": {
          "options": {
            "description": "Options for the update.",
            "allOf": [
              {
                "$ref": "#/components/schemas/StartUpdateOptions"
              }
            ]
          },
          "targets": {
            "description": "The SP identifiers to start the update with.",
            "allOf": [
              {
                "$ref": "#/components/schemas/UpdateTargets"
              }
            ]
          }
        },
        "required": [
          "options",
          "targets"
        ]
      },
      "StepComponentSummaryForGenericSpec": {
        "type": "object",
        "properties": {
          "component": {
            "description": "The component."
          },
          "total_component_steps": {
            "description": "The number of steps present in this component.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          }
        },
        "required": [
          "component",
          "total_component_steps"
        ]
      },
      "StepComponentSummaryForUplinkPreflightCheckSpec": {
        "type": "object",
        "properties": {
          "component": {
            "description": "The component.",
            "type": "string"
          },
          "total_component_steps": {
            "description": "The number of steps present in this component.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          }
        },
        "required": [
          "component",
          "total_component_steps"
        ]
      },
      "StepComponentSummaryForWicketdEngineSpec": {
        "type": "object",
        "properties": {
          "component": {
            "description": "The component.",
            "allOf": [
              {
                "$ref": "#/components/schemas/UpdateComponent"
              }
            ]
          },
          "total_component_steps": {
            "description": "The number of steps present in this component.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          }
        },
        "required": [
          "component",
          "total_component_steps"
        ]
      },
      "StepEventForGenericSpec": {
        "x-rust-type": {
          "crate": "oxide-update-engine-types",
          "parameters": [
            {
              "x-rust-type": {
                "crate": "oxide-update-engine-types",
                "path": "oxide_update_engine_types::spec::GenericSpec",
                "version": "0.1.2"
              }
            }
          ],
          "path": "oxide_update_engine_types::events::StepEvent",
          "version": "0.1.2"
        },
        "type": "object",
        "properties": {
          "data": {
            "description": "The kind of event this is.",
            "allOf": [
              {
                "$ref": "#/components/schemas/StepEventKindForGenericSpec"
              }
            ]
          },
          "event_index": {
            "description": "A monotonically increasing index for this `StepEvent`.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          },
          "execution_id": {
            "description": "The execution ID.",
            "allOf": [
              {
                "$ref": "#/components/schemas/ExecutionUuid"
              }
            ]
          },
          "spec": {
            "description": "The specification that this event belongs to.",
            "type": "string"
          },
          "total_elapsed": {
            "description": "Total time elapsed since the start of execution.",
            "allOf": [
              {
                "$ref": "#/components/schemas/Duration"
              }
            ]
          }
        },
        "required": [
          "data",
          "event_index",
          "execution_id",
          "spec",
          "total_elapsed"
        ]
      },
      "StepEventForUplinkPreflightCheckSpec": {
        "type": "object",
        "properties": {
          "data": {
            "description": "The kind of event this is.",
            "allOf": [
              {
                "$ref": "#/components/schemas/StepEventKindForUplinkPreflightCheckSpec"
              }
            ]
          },
          "event_index": {
            "description": "A monotonically increasing index for this `StepEvent`.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          },
          "execution_id": {
            "description": "The execution ID.",
            "allOf": [
              {
                "$ref": "#/components/schemas/ExecutionUuid"
              }
            ]
          },
          "spec": {
            "description": "The specification that this event belongs to.",
            "type": "string"
          },
          "total_elapsed": {
            "description": "Total time elapsed since the start of execution.",
            "allOf": [
              {
                "$ref": "#/components/schemas/Duration"
              }
            ]
          }
        },
        "required": [
          "data",
          "event_index",
          "execution_id",
          "spec",
          "total_elapsed"
        ]
      },
      "StepEventForWicketdEngineSpec": {
        "type": "object",
        "properties": {
          "data": {
            "description": "The kind of event this is.",
            "allOf": [
              {
                "$ref": "#/components/schemas/StepEventKindForWicketdEngineSpec"
              }
            ]
          },
          "event_index": {
            "description": "A monotonically increasing index for this `StepEvent`.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          },
          "execution_id": {
            "description": "The execution ID.",
            "allOf": [
              {
                "$ref": "#/components/schemas/ExecutionUuid"
              }
            ]
          },
          "spec": {
            "description": "The specification that this event belongs to.",
            "type": "string"
          },
          "total_elapsed": {
            "description": "Total time elapsed since the start of execution.",
            "allOf": [
              {
                "$ref": "#/components/schemas/Duration"
              }
            ]
          }
        },
        "required": [
          "data",
          "event_index",
          "execution_id",
          "spec",
          "total_elapsed"
        ]
      },
      "StepEventKindForGenericSpec": {
        "oneOf": [
          {
            "description": "No steps were defined, and the executor exited without doing anything.\n\nThis is a terminal event: it is guaranteed that no more events will be seen after this one.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "no_steps_defined"
                ]
              }
            },
            "required": [
              "kind"
            ]
          },
          {
            "description": "Execution was started.\n\nThis is an initial event -- it is always expected to be the first event received from the event stream.",
            "type": "object",
            "properties": {
              "components": {
                "description": "A list of components, along with the number of items each component has.",
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/StepComponentSummaryForGenericSpec"
                }
              },
              "first_step": {
                "description": "Information about the first step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForGenericSpec"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "execution_started"
                ]
              },
              "steps": {
                "description": "The list of steps that will be executed.",
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/StepInfoForGenericSpec"
                }
              }
            },
            "required": [
              "components",
              "first_step",
              "kind",
              "steps"
            ]
          },
          {
            "description": "Progress was reset along an attempt, and this attempt is going down a different path.",
            "type": "object",
            "properties": {
              "attempt": {
                "description": "The current attempt number.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "The amount of time this attempt has taken so far.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "progress_reset"
                ]
              },
              "message": {
                "description": "A message associated with the reset.",
                "type": "string"
              },
              "metadata": {
                "description": "Progress-related metadata associated with this attempt."
              },
              "step": {
                "description": "Information about the step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForGenericSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt",
              "attempt_elapsed",
              "kind",
              "message",
              "metadata",
              "step",
              "step_elapsed"
            ]
          },
          {
            "description": "An attempt failed and this step is being retried.",
            "type": "object",
            "properties": {
              "attempt_elapsed": {
                "description": "The amount of time the previous attempt took.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "attempt_retry"
                ]
              },
              "message": {
                "description": "A message associated with the retry.",
                "type": "string"
              },
              "next_attempt": {
                "description": "The attempt number for the next attempt.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "step": {
                "description": "Information about the step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForGenericSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt_elapsed",
              "kind",
              "message",
              "next_attempt",
              "step",
              "step_elapsed"
            ]
          },
          {
            "description": "A step is complete and the next step has been started.",
            "type": "object",
            "properties": {
              "attempt": {
                "description": "The attempt number that completed.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "The time it took for this attempt to complete.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "step_completed"
                ]
              },
              "next_step": {
                "description": "The next step that is being started.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForGenericSpec"
                  }
                ]
              },
              "outcome": {
                "description": "The outcome of the step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepOutcomeForGenericSpec"
                  }
                ]
              },
              "step": {
                "description": "Information about the step that just completed.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForGenericSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt",
              "attempt_elapsed",
              "kind",
              "next_step",
              "outcome",
              "step",
              "step_elapsed"
            ]
          },
          {
            "description": "Execution is complete.\n\nThis is a terminal event: it is guaranteed that no more events will be seen after this one.",
            "type": "object",
            "properties": {
              "attempt_elapsed": {
                "description": "The time it took for this attempt to complete.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "execution_completed"
                ]
              },
              "last_attempt": {
                "description": "The attempt number that completed.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "last_outcome": {
                "description": "The outcome of the last step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepOutcomeForGenericSpec"
                  }
                ]
              },
              "last_step": {
                "description": "Information about the last step that completed.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForGenericSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt_elapsed",
              "kind",
              "last_attempt",
              "last_outcome",
              "last_step",
              "step_elapsed"
            ]
          },
          {
            "description": "Execution failed.\n\nThis is a terminal event: it is guaranteed that no more events will be seen after this one.",
            "type": "object",
            "properties": {
              "attempt_elapsed": {
                "description": "The time it took for this attempt to complete.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "causes": {
                "description": "A chain of causes associated with the failure.",
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "failed_step": {
                "description": "Information about the step that failed.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForGenericSpec"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "execution_failed"
                ]
              },
              "message": {
                "description": "A message associated with the failure.",
                "type": "string"
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "total_attempts": {
                "description": "The total number of attempts that were performed before the step failed.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              }
            },
            "required": [
              "attempt_elapsed",
              "causes",
              "failed_step",
              "kind",
              "message",
              "step_elapsed",
              "total_attempts"
            ]
          },
          {
            "description": "Execution aborted by an external user.\n\nThis is a terminal event: it is guaranteed that no more events will be seen after this one.",
            "type": "object",
            "properties": {
              "aborted_step": {
                "description": "Information about the step that was running at the time execution was aborted.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForGenericSpec"
                  }
                ]
              },
              "attempt": {
                "description": "The attempt that was running at the time the step was aborted.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "The time it took for this attempt to complete.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "execution_aborted"
                ]
              },
              "message": {
                "description": "A message associated with the abort.",
                "type": "string"
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "aborted_step",
              "attempt",
              "attempt_elapsed",
              "kind",
              "message",
              "step_elapsed"
            ]
          },
          {
            "description": "A nested step event occurred.",
            "type": "object",
            "properties": {
              "attempt": {
                "description": "The current attempt number.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "The time it took for this attempt to complete.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "event": {
                "description": "The event that occurred.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepEventForGenericSpec"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "nested"
                ]
              },
              "step": {
                "description": "Information about the step that's occurring.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForGenericSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt",
              "attempt_elapsed",
              "event",
              "kind",
              "step",
              "step_elapsed"
            ]
          },
          {
            "description": "Future variants that might be unknown.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "unknown"
                ]
              }
            },
            "required": [
              "kind"
            ]
          }
        ]
      },
      "StepEventKindForUplinkPreflightCheckSpec": {
        "oneOf": [
          {
            "description": "No steps were defined, and the executor exited without doing anything.\n\nThis is a terminal event: it is guaranteed that no more events will be seen after this one.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "no_steps_defined"
                ]
              }
            },
            "required": [
              "kind"
            ]
          },
          {
            "description": "Execution was started.\n\nThis is an initial event -- it is always expected to be the first event received from the event stream.",
            "type": "object",
            "properties": {
              "components": {
                "description": "A list of components, along with the number of items each component has.",
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/StepComponentSummaryForUplinkPreflightCheckSpec"
                }
              },
              "first_step": {
                "description": "Information about the first step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForUplinkPreflightCheckSpec"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "execution_started"
                ]
              },
              "steps": {
                "description": "The list of steps that will be executed.",
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/StepInfoForUplinkPreflightCheckSpec"
                }
              }
            },
            "required": [
              "components",
              "first_step",
              "kind",
              "steps"
            ]
          },
          {
            "description": "Progress was reset along an attempt, and this attempt is going down a different path.",
            "type": "object",
            "properties": {
              "attempt": {
                "description": "The current attempt number.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "The amount of time this attempt has taken so far.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "progress_reset"
                ]
              },
              "message": {
                "description": "A message associated with the reset.",
                "type": "string"
              },
              "metadata": {
                "description": "Progress-related metadata associated with this attempt.",
                "type": "string"
              },
              "step": {
                "description": "Information about the step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForUplinkPreflightCheckSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt",
              "attempt_elapsed",
              "kind",
              "message",
              "metadata",
              "step",
              "step_elapsed"
            ]
          },
          {
            "description": "An attempt failed and this step is being retried.",
            "type": "object",
            "properties": {
              "attempt_elapsed": {
                "description": "The amount of time the previous attempt took.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "attempt_retry"
                ]
              },
              "message": {
                "description": "A message associated with the retry.",
                "type": "string"
              },
              "next_attempt": {
                "description": "The attempt number for the next attempt.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "step": {
                "description": "Information about the step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForUplinkPreflightCheckSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt_elapsed",
              "kind",
              "message",
              "next_attempt",
              "step",
              "step_elapsed"
            ]
          },
          {
            "description": "A step is complete and the next step has been started.",
            "type": "object",
            "properties": {
              "attempt": {
                "description": "The attempt number that completed.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "The time it took for this attempt to complete.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "step_completed"
                ]
              },
              "next_step": {
                "description": "The next step that is being started.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForUplinkPreflightCheckSpec"
                  }
                ]
              },
              "outcome": {
                "description": "The outcome of the step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepOutcomeForUplinkPreflightCheckSpec"
                  }
                ]
              },
              "step": {
                "description": "Information about the step that just completed.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForUplinkPreflightCheckSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt",
              "attempt_elapsed",
              "kind",
              "next_step",
              "outcome",
              "step",
              "step_elapsed"
            ]
          },
          {
            "description": "Execution is complete.\n\nThis is a terminal event: it is guaranteed that no more events will be seen after this one.",
            "type": "object",
            "properties": {
              "attempt_elapsed": {
                "description": "The time it took for this attempt to complete.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "execution_completed"
                ]
              },
              "last_attempt": {
                "description": "The attempt number that completed.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "last_outcome": {
                "description": "The outcome of the last step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepOutcomeForUplinkPreflightCheckSpec"
                  }
                ]
              },
              "last_step": {
                "description": "Information about the last step that completed.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForUplinkPreflightCheckSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt_elapsed",
              "kind",
              "last_attempt",
              "last_outcome",
              "last_step",
              "step_elapsed"
            ]
          },
          {
            "description": "Execution failed.\n\nThis is a terminal event: it is guaranteed that no more events will be seen after this one.",
            "type": "object",
            "properties": {
              "attempt_elapsed": {
                "description": "The time it took for this attempt to complete.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "causes": {
                "description": "A chain of causes associated with the failure.",
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "failed_step": {
                "description": "Information about the step that failed.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForUplinkPreflightCheckSpec"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "execution_failed"
                ]
              },
              "message": {
                "description": "A message associated with the failure.",
                "type": "string"
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "total_attempts": {
                "description": "The total number of attempts that were performed before the step failed.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              }
            },
            "required": [
              "attempt_elapsed",
              "causes",
              "failed_step",
              "kind",
              "message",
              "step_elapsed",
              "total_attempts"
            ]
          },
          {
            "description": "Execution aborted by an external user.\n\nThis is a terminal event: it is guaranteed that no more events will be seen after this one.",
            "type": "object",
            "properties": {
              "aborted_step": {
                "description": "Information about the step that was running at the time execution was aborted.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForUplinkPreflightCheckSpec"
                  }
                ]
              },
              "attempt": {
                "description": "The attempt that was running at the time the step was aborted.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "The time it took for this attempt to complete.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "execution_aborted"
                ]
              },
              "message": {
                "description": "A message associated with the abort.",
                "type": "string"
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "aborted_step",
              "attempt",
              "attempt_elapsed",
              "kind",
              "message",
              "step_elapsed"
            ]
          },
          {
            "description": "A nested step event occurred.",
            "type": "object",
            "properties": {
              "attempt": {
                "description": "The current attempt number.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "The time it took for this attempt to complete.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "event": {
                "description": "The event that occurred.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepEventForGenericSpec"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "nested"
                ]
              },
              "step": {
                "description": "Information about the step that's occurring.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForUplinkPreflightCheckSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt",
              "attempt_elapsed",
              "event",
              "kind",
              "step",
              "step_elapsed"
            ]
          },
          {
            "description": "Future variants that might be unknown.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "unknown"
                ]
              }
            },
            "required": [
              "kind"
            ]
          }
        ]
      },
      "StepEventKindForWicketdEngineSpec": {
        "oneOf": [
          {
            "description": "No steps were defined, and the executor exited without doing anything.\n\nThis is a terminal event: it is guaranteed that no more events will be seen after this one.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "no_steps_defined"
                ]
              }
            },
            "required": [
              "kind"
            ]
          },
          {
            "description": "Execution was started.\n\nThis is an initial event -- it is always expected to be the first event received from the event stream.",
            "type": "object",
            "properties": {
              "components": {
                "description": "A list of components, along with the number of items each component has.",
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/StepComponentSummaryForWicketdEngineSpec"
                }
              },
              "first_step": {
                "description": "Information about the first step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForWicketdEngineSpec"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "execution_started"
                ]
              },
              "steps": {
                "description": "The list of steps that will be executed.",
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/StepInfoForWicketdEngineSpec"
                }
              }
            },
            "required": [
              "components",
              "first_step",
              "kind",
              "steps"
            ]
          },
          {
            "description": "Progress was reset along an attempt, and this attempt is going down a different path.",
            "type": "object",
            "properties": {
              "attempt": {
                "description": "The current attempt number.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "The amount of time this attempt has taken so far.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "progress_reset"
                ]
              },
              "message": {
                "description": "A message associated with the reset.",
                "type": "string"
              },
              "metadata": {
                "description": "Progress-related metadata associated with this attempt."
              },
              "step": {
                "description": "Information about the step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForWicketdEngineSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt",
              "attempt_elapsed",
              "kind",
              "message",
              "metadata",
              "step",
              "step_elapsed"
            ]
          },
          {
            "description": "An attempt failed and this step is being retried.",
            "type": "object",
            "properties": {
              "attempt_elapsed": {
                "description": "The amount of time the previous attempt took.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "attempt_retry"
                ]
              },
              "message": {
                "description": "A message associated with the retry.",
                "type": "string"
              },
              "next_attempt": {
                "description": "The attempt number for the next attempt.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "step": {
                "description": "Information about the step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForWicketdEngineSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt_elapsed",
              "kind",
              "message",
              "next_attempt",
              "step",
              "step_elapsed"
            ]
          },
          {
            "description": "A step is complete and the next step has been started.",
            "type": "object",
            "properties": {
              "attempt": {
                "description": "The attempt number that completed.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "The time it took for this attempt to complete.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "step_completed"
                ]
              },
              "next_step": {
                "description": "The next step that is being started.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForWicketdEngineSpec"
                  }
                ]
              },
              "outcome": {
                "description": "The outcome of the step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepOutcomeForWicketdEngineSpec"
                  }
                ]
              },
              "step": {
                "description": "Information about the step that just completed.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForWicketdEngineSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt",
              "attempt_elapsed",
              "kind",
              "next_step",
              "outcome",
              "step",
              "step_elapsed"
            ]
          },
          {
            "description": "Execution is complete.\n\nThis is a terminal event: it is guaranteed that no more events will be seen after this one.",
            "type": "object",
            "properties": {
              "attempt_elapsed": {
                "description": "The time it took for this attempt to complete.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "execution_completed"
                ]
              },
              "last_attempt": {
                "description": "The attempt number that completed.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "last_outcome": {
                "description": "The outcome of the last step.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepOutcomeForWicketdEngineSpec"
                  }
                ]
              },
              "last_step": {
                "description": "Information about the last step that completed.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForWicketdEngineSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt_elapsed",
              "kind",
              "last_attempt",
              "last_outcome",
              "last_step",
              "step_elapsed"
            ]
          },
          {
            "description": "Execution failed.\n\nThis is a terminal event: it is guaranteed that no more events will be seen after this one.",
            "type": "object",
            "properties": {
              "attempt_elapsed": {
                "description": "The time it took for this attempt to complete.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "causes": {
                "description": "A chain of causes associated with the failure.",
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "failed_step": {
                "description": "Information about the step that failed.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForWicketdEngineSpec"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "execution_failed"
                ]
              },
              "message": {
                "description": "A message associated with the failure.",
                "type": "string"
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "total_attempts": {
                "description": "The total number of attempts that were performed before the step failed.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              }
            },
            "required": [
              "attempt_elapsed",
              "causes",
              "failed_step",
              "kind",
              "message",
              "step_elapsed",
              "total_attempts"
            ]
          },
          {
            "description": "Execution aborted by an external user.\n\nThis is a terminal event: it is guaranteed that no more events will be seen after this one.",
            "type": "object",
            "properties": {
              "aborted_step": {
                "description": "Information about the step that was running at the time execution was aborted.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForWicketdEngineSpec"
                  }
                ]
              },
              "attempt": {
                "description": "The attempt that was running at the time the step was aborted.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "The time it took for this attempt to complete.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "execution_aborted"
                ]
              },
              "message": {
                "description": "A message associated with the abort.",
                "type": "string"
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "aborted_step",
              "attempt",
              "attempt_elapsed",
              "kind",
              "message",
              "step_elapsed"
            ]
          },
          {
            "description": "A nested step event occurred.",
            "type": "object",
            "properties": {
              "attempt": {
                "description": "The current attempt number.",
                "type": "integer",
                "format": "uint",
                "minimum": 0
              },
              "attempt_elapsed": {
                "description": "The time it took for this attempt to complete.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              },
              "event": {
                "description": "The event that occurred.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepEventForGenericSpec"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "nested"
                ]
              },
              "step": {
                "description": "Information about the step that's occurring.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/StepInfoWithMetadataForWicketdEngineSpec"
                  }
                ]
              },
              "step_elapsed": {
                "description": "Total time elapsed since the start of the step. Includes prior attempts.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Duration"
                  }
                ]
              }
            },
            "required": [
              "attempt",
              "attempt_elapsed",
              "event",
              "kind",
              "step",
              "step_elapsed"
            ]
          },
          {
            "description": "Future variants that might be unknown.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "unknown"
                ]
              }
            },
            "required": [
              "kind"
            ]
          }
        ]
      },
      "StepInfoForGenericSpec": {
        "description": "Serializable information about a step.",
        "type": "object",
        "properties": {
          "component": {
            "description": "The component that this step is part of."
          },
          "component_index": {
            "description": "The index of the step within the component.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          },
          "description": {
            "description": "The description for this step.",
            "type": "string"
          },
          "id": {
            "description": "An identifier for this step."
          },
          "index": {
            "description": "The index of the step within all steps to be executed.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          },
          "total_component_steps": {
            "description": "The total number of steps in this component.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          }
        },
        "required": [
          "component",
          "component_index",
          "description",
          "id",
          "index",
          "total_component_steps"
        ]
      },
      "StepInfoForUplinkPreflightCheckSpec": {
        "description": "Serializable information about a step.",
        "type": "object",
        "properties": {
          "component": {
            "description": "The component that this step is part of.",
            "type": "string"
          },
          "component_index": {
            "description": "The index of the step within the component.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          },
          "description": {
            "description": "The description for this step.",
            "type": "string"
          },
          "id": {
            "description": "An identifier for this step.",
            "allOf": [
              {
                "$ref": "#/components/schemas/UplinkPreflightStepId"
              }
            ]
          },
          "index": {
            "description": "The index of the step within all steps to be executed.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          },
          "total_component_steps": {
            "description": "The total number of steps in this component.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          }
        },
        "required": [
          "component",
          "component_index",
          "description",
          "id",
          "index",
          "total_component_steps"
        ]
      },
      "StepInfoForWicketdEngineSpec": {
        "description": "Serializable information about a step.",
        "type": "object",
        "properties": {
          "component": {
            "description": "The component that this step is part of.",
            "allOf": [
              {
                "$ref": "#/components/schemas/UpdateComponent"
              }
            ]
          },
          "component_index": {
            "description": "The index of the step within the component.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          },
          "description": {
            "description": "The description for this step.",
            "type": "string"
          },
          "id": {
            "description": "An identifier for this step.",
            "allOf": [
              {
                "$ref": "#/components/schemas/UpdateStepId"
              }
            ]
          },
          "index": {
            "description": "The index of the step within all steps to be executed.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          },
          "total_component_steps": {
            "description": "The total number of steps in this component.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          }
        },
        "required": [
          "component",
          "component_index",
          "description",
          "id",
          "index",
          "total_component_steps"
        ]
      },
      "StepInfoWithMetadataForGenericSpec": {
        "description": "Serializable information about a step.",
        "type": "object",
        "properties": {
          "info": {
            "description": "Information about this step.",
            "allOf": [
              {
                "$ref": "#/components/schemas/StepInfoForGenericSpec"
              }
            ]
          },
          "metadata": {
            "nullable": true,
            "description": "Additional metadata associated with this step."
          }
        },
        "required": [
          "info"
        ]
      },
      "StepInfoWithMetadataForUplinkPreflightCheckSpec": {
        "description": "Serializable information about a step.",
        "type": "object",
        "properties": {
          "info": {
            "description": "Information about this step.",
            "allOf": [
              {
                "$ref": "#/components/schemas/StepInfoForUplinkPreflightCheckSpec"
              }
            ]
          },
          "metadata": {
            "nullable": true,
            "description": "Additional metadata associated with this step.",
            "type": "string",
            "enum": [
              null
            ]
          }
        },
        "required": [
          "info"
        ]
      },
      "StepInfoWithMetadataForWicketdEngineSpec": {
        "description": "Serializable information about a step.",
        "type": "object",
        "properties": {
          "info": {
            "description": "Information about this step.",
            "allOf": [
              {
                "$ref": "#/components/schemas/StepInfoForWicketdEngineSpec"
              }
            ]
          },
          "metadata": {
            "nullable": true,
            "description": "Additional metadata associated with this step."
          }
        },
        "required": [
          "info"
        ]
      },
      "StepOutcomeForGenericSpec": {
        "oneOf": [
          {
            "description": "The step completed successfully.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "success"
                ]
              },
              "message": {
                "nullable": true,
                "description": "An optional message associated with this step.",
                "type": "string"
              },
              "metadata": {
                "nullable": true,
                "description": "Optional completion metadata associated with the step."
              }
            },
            "required": [
              "kind"
            ]
          },
          {
            "description": "The step completed with a warning.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "warning"
                ]
              },
              "message": {
                "description": "A warning message.",
                "type": "string"
              },
              "metadata": {
                "nullable": true,
                "description": "Optional completion metadata associated with the step."
              }
            },
            "required": [
              "kind",
              "message"
            ]
          },
          {
            "description": "The step was skipped with a message.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "skipped"
                ]
              },
              "message": {
                "description": "Message associated with the skip.",
                "type": "string"
              },
              "metadata": {
                "nullable": true,
                "description": "Optional metadata associated with the skip."
              }
            },
            "required": [
              "kind",
              "message"
            ]
          }
        ]
      },
      "StepOutcomeForUplinkPreflightCheckSpec": {
        "oneOf": [
          {
            "description": "The step completed successfully.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "success"
                ]
              },
              "message": {
                "nullable": true,
                "description": "An optional message associated with this step.",
                "type": "string"
              },
              "metadata": {
                "nullable": true,
                "description": "Optional completion metadata associated with the step.",
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "required": [
              "kind"
            ]
          },
          {
            "description": "The step completed with a warning.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "warning"
                ]
              },
              "message": {
                "description": "A warning message.",
                "type": "string"
              },
              "metadata": {
                "nullable": true,
                "description": "Optional completion metadata associated with the step.",
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "required": [
              "kind",
              "message"
            ]
          },
          {
            "description": "The step was skipped with a message.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "skipped"
                ]
              },
              "message": {
                "description": "Message associated with the skip.",
                "type": "string"
              },
              "metadata": {
                "nullable": true,
                "description": "Optional metadata associated with the skip.",
                "type": "string",
                "enum": [
                  null
                ]
              }
            },
            "required": [
              "kind",
              "message"
            ]
          }
        ]
      },
      "StepOutcomeForWicketdEngineSpec": {
        "oneOf": [
          {
            "description": "The step completed successfully.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "success"
                ]
              },
              "message": {
                "nullable": true,
                "description": "An optional message associated with this step.",
                "type": "string"
              },
              "metadata": {
                "nullable": true,
                "description": "Optional completion metadata associated with the step."
              }
            },
            "required": [
              "kind"
            ]
          },
          {
            "description": "The step completed with a warning.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "warning"
                ]
              },
              "message": {
                "description": "A warning message.",
                "type": "string"
              },
              "metadata": {
                "nullable": true,
                "description": "Optional completion metadata associated with the step."
              }
            },
            "required": [
              "kind",
              "message"
            ]
          },
          {
            "description": "The step was skipped with a message.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "skipped"
                ]
              },
              "message": {
                "description": "Message associated with the skip.",
                "type": "string"
              },
              "metadata": {
                "nullable": true,
                "description": "Optional metadata associated with the skip."
              }
            },
            "required": [
              "kind",
              "message"
            ]
          }
        ]
      },
      "Transceiver": {
        "description": "A transceiver in the switch's front ports.",
        "type": "object",
        "properties": {
          "datapath": {
            "description": "Status of the transceiver's machinery for carrying data, the \"datapath\".",
            "x-rust-type": {
              "crate": "std",
              "parameters": [
                {
                  "$ref": "#/components/schemas/Datapath"
                },
                {
                  "type": "string"
                }
              ],
              "path": "::std::result::Result",
              "version": "*"
            },
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "ok": {
                    "$ref": "#/components/schemas/Datapath"
                  }
                },
                "required": [
                  "ok"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "err": {
                    "type": "string"
                  }
                },
                "required": [
                  "err"
                ]
              }
            ]
          },
          "monitors": {
            "description": "Environmental monitoring data, such as temperature or optical power.",
            "x-rust-type": {
              "crate": "std",
              "parameters": [
                {
                  "$ref": "#/components/schemas/Monitors"
                },
                {
                  "type": "string"
                }
              ],
              "path": "::std::result::Result",
              "version": "*"
            },
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "ok": {
                    "$ref": "#/components/schemas/Monitors"
                  }
                },
                "required": [
                  "ok"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "err": {
                    "type": "string"
                  }
                },
                "required": [
                  "err"
                ]
              }
            ]
          },
          "port": {
            "description": "The port in which the transceiver sits.",
            "type": "string"
          },
          "power": {
            "description": "Information about the power state of the transceiver.",
            "x-rust-type": {
              "crate": "std",
              "parameters": [
                {
                  "$ref": "#/components/schemas/PowerMode"
                },
                {
                  "type": "string"
                }
              ],
              "path": "::std::result::Result",
              "version": "*"
            },
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "ok": {
                    "$ref": "#/components/schemas/PowerMode"
                  }
                },
                "required": [
                  "ok"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "err": {
                    "type": "string"
                  }
                },
                "required": [
                  "err"
                ]
              }
            ]
          },
          "status": {
            "description": "The general status of the transceiver, such as presence and faults.",
            "x-rust-type": {
              "crate": "std",
              "parameters": [
                {
                  "$ref": "#/components/schemas/ExtendedStatus"
                },
                {
                  "type": "string"
                }
              ],
              "path": "::std::result::Result",
              "version": "*"
            },
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "ok": {
                    "$ref": "#/components/schemas/ExtendedStatus"
                  }
                },
                "required": [
                  "ok"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "err": {
                    "type": "string"
                  }
                },
                "required": [
                  "err"
                ]
              }
            ]
          },
          "vendor": {
            "description": "Details about the vendor, part number, and serial number.",
            "x-rust-type": {
              "crate": "std",
              "parameters": [
                {
                  "$ref": "#/components/schemas/VendorInfo"
                },
                {
                  "type": "string"
                }
              ],
              "path": "::std::result::Result",
              "version": "*"
            },
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "ok": {
                    "$ref": "#/components/schemas/VendorInfo"
                  }
                },
                "required": [
                  "ok"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "err": {
                    "type": "string"
                  }
                },
                "required": [
                  "err"
                ]
              }
            ]
          }
        },
        "required": [
          "datapath",
          "monitors",
          "port",
          "power",
          "status",
          "vendor"
        ]
      },
      "TransceiverInventorySnapshot": {
        "description": "A snapshot of the transceiver inventory at a given time.",
        "type": "object",
        "properties": {
          "inventory": {
            "description": "The transceivers in each switch.",
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/Transceiver"
              }
            }
          },
          "last_seen": {
            "$ref": "#/components/schemas/Duration"
          }
        },
        "required": [
          "inventory",
          "last_seen"
        ]
      },
      "TxEqConfig": {
        "description": "Per-port tx-eq overrides.  This can be used to fine-tune the transceiver equalization settings to improve signal integrity.",
        "type": "object",
        "properties": {
          "main": {
            "nullable": true,
            "description": "Main tap",
            "type": "integer",
            "format": "int32"
          },
          "post1": {
            "nullable": true,
            "description": "Post-cursor tap1",
            "type": "integer",
            "format": "int32"
          },
          "post2": {
            "nullable": true,
            "description": "Post-cursor tap2",
            "type": "integer",
            "format": "int32"
          },
          "pre1": {
            "nullable": true,
            "description": "Pre-cursor tap1",
            "type": "integer",
            "format": "int32"
          },
          "pre2": {
            "nullable": true,
            "description": "Pre-cursor tap2",
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "UpdateComponent": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "component": {
                "type": "string",
                "enum": [
                  "rot_bootloader"
                ]
              }
            },
            "required": [
              "component"
            ]
          },
          {
            "type": "object",
            "properties": {
              "component": {
                "type": "string",
                "enum": [
                  "rot"
                ]
              }
            },
            "required": [
              "component"
            ]
          },
          {
            "type": "object",
            "properties": {
              "component": {
                "type": "string",
                "enum": [
                  "sp"
                ]
              }
            },
            "required": [
              "component"
            ]
          },
          {
            "type": "object",
            "properties": {
              "component": {
                "type": "string",
                "enum": [
                  "host"
                ]
              }
            },
            "required": [
              "component"
            ]
          }
        ]
      },
      "UpdateSimulatedResult": {
        "description": "A simulated result for a component update.\n\nUsed by [`StartUpdateOptions`].",
        "type": "string",
        "enum": [
          "success",
          "warning",
          "skipped",
          "failure"
        ]
      },
      "UpdateStepId": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "test_step"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "set_host_power_state"
                ]
              },
              "state": {
                "$ref": "#/components/schemas/PowerState"
              }
            },
            "required": [
              "id",
              "state"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "interrogate_rot_bootloader"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "interrogate_rot"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "interrogate_sp"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "sp_component_update"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "setting_installinator_image_id"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "clearing_installinator_image_id"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "setting_host_startup_options"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "waiting_for_trampoline_phase2_upload"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "fetch_host_type"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "check_host_type"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "downloading_installinator"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "running_installinator"
                ]
              }
            },
            "required": [
              "id"
            ]
          }
        ]
      },
      "UpdateTargets": {
        "description": "A non-empty set of service processors to act on.",
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/SpIdentifier"
        },
        "minItems": 1,
        "uniqueItems": true
      },
      "UpdateTestError": {
        "oneOf": [
          {
            "description": "Simulate an error where the operation fails to complete.",
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "fail"
                ]
              }
            },
            "required": [
              "kind"
            ]
          },
          {
            "description": "Simulate an issue where the operation times out.",
            "type": "object",
            "properties": {
              "content": {
                "type": "object",
                "properties": {
                  "secs": {
                    "description": "The number of seconds to time out after.",
                    "type": "integer",
                    "format": "uint64",
                    "minimum": 0
                  }
                },
                "required": [
                  "secs"
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "timeout"
                ]
              }
            },
            "required": [
              "content",
              "kind"
            ]
          }
        ]
      },
      "UplinkPreflightStepId": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "configure_switch"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "wait_for_l1_link"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "configure_address"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "configure_routing"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "check_external_dns_connectivity"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "check_external_ntp_connectivity"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "cleanup_routing"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "cleanup_address"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "cleanup_l1"
                ]
              }
            },
            "required": [
              "id"
            ]
          }
        ]
      },
      "UserSpecifiedBgpPeerConfig": {
        "description": "User-specified configuration for a BGP peer.\n\nThis is similar to the internal BGP peer configuration, except it does not carry the sensitive `md5_auth_key`; the operator provides the key separately, referenced by `auth_key_id`.",
        "type": "object",
        "properties": {
          "addr": {
            "description": "Address of the peer.",
            "allOf": [
              {
                "$ref": "#/components/schemas/UserSpecifiedRouterPeerAddr"
              }
            ]
          },
          "allowed_export": {
            "description": "Apply export policy to this peer with an allow list.",
            "default": null,
            "allOf": [
              {
                "$ref": "#/components/schemas/UserSpecifiedImportExportPolicy"
              }
            ]
          },
          "allowed_import": {
            "description": "Apply import policy to this peer with an allow list.",
            "default": null,
            "allOf": [
              {
                "$ref": "#/components/schemas/UserSpecifiedImportExportPolicy"
              }
            ]
          },
          "asn": {
            "description": "The autonomous system number of the router the peer belongs to.",
            "type": "integer",
            "format": "uint32",
            "minimum": 0
          },
          "auth_key_id": {
            "nullable": true,
            "description": "The key identifier for authentication to use with the peer.",
            "default": null,
            "allOf": [
              {
                "$ref": "#/components/schemas/BgpAuthKeyId"
              }
            ]
          },
          "communities": {
            "description": "Include the provided communities in updates sent to the peer.",
            "default": [],
            "type": "array",
            "items": {
              "type": "integer",
              "format": "uint32",
              "minimum": 0
            }
          },
          "connect_retry": {
            "nullable": true,
            "description": "The interval in seconds between peer connection retry attempts. Defaults to 3 seconds.",
            "type": "integer",
            "format": "uint64",
            "minimum": 0
          },
          "delay_open": {
            "nullable": true,
            "description": "How long to delay sending open messages to a peer, in seconds. Defaults to 0.",
            "type": "integer",
            "format": "uint64",
            "minimum": 0
          },
          "enforce_first_as": {
            "description": "Enforce that the first AS in paths received from this peer is the peer's AS.",
            "default": false,
            "type": "boolean"
          },
          "hold_time": {
            "nullable": true,
            "description": "How long to keep a session alive without a keepalive, in seconds. Defaults to 6 seconds.",
            "type": "integer",
            "format": "uint64",
            "minimum": 0
          },
          "idle_hold_time": {
            "nullable": true,
            "description": "How long to keep a peer in idle after a state machine reset, in seconds. Defaults to 3 seconds.",
            "type": "integer",
            "format": "uint64",
            "minimum": 0
          },
          "keepalive": {
            "nullable": true,
            "description": "The interval to send keepalive messages at, in seconds. Defaults to 2 seconds.",
            "type": "integer",
            "format": "uint64",
            "minimum": 0
          },
          "local_pref": {
            "nullable": true,
            "description": "Apply a local preference to routes received from this peer.",
            "default": null,
            "type": "integer",
            "format": "uint32",
            "minimum": 0
          },
          "min_ttl": {
            "nullable": true,
            "description": "Require messages from a peer have a minimum IP time to live field.",
            "default": null,
            "type": "integer",
            "format": "uint8",
            "minimum": 0
          },
          "multi_exit_discriminator": {
            "nullable": true,
            "description": "Apply the provided multi-exit discriminator (MED) updates sent to the peer.",
            "default": null,
            "type": "integer",
            "format": "uint32",
            "minimum": 0
          },
          "port": {
            "description": "Switch port the peer is reachable on.",
            "type": "string"
          },
          "remote_asn": {
            "nullable": true,
            "description": "Require that a peer has a specified ASN.",
            "default": null,
            "type": "integer",
            "format": "uint32",
            "minimum": 0
          },
          "router_lifetime": {
            "description": "Router lifetime in seconds for unnumbered BGP peers.",
            "default": 0,
            "allOf": [
              {
                "$ref": "#/components/schemas/RouterLifetimeConfig"
              }
            ]
          },
          "src_addr": {
            "nullable": true,
            "description": "The optional source address to use for starting a BGP session with a numbered peer.",
            "default": null,
            "type": "string",
            "format": "ip"
          },
          "vlan_id": {
            "nullable": true,
            "description": "Associate a VLAN ID with a BGP peer session.",
            "default": null,
            "type": "integer",
            "format": "uint16",
            "minimum": 0
          }
        },
        "required": [
          "addr",
          "asn",
          "port"
        ],
        "additionalProperties": false
      },
      "UserSpecifiedImportExportPolicy": {
        "nullable": true,
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/IpNet"
        }
      },
      "UserSpecifiedPortConfig": {
        "description": "A user-specified port configuration.",
        "oneOf": [
          {
            "description": "A front port intended for use as an uplink",
            "type": "object",
            "properties": {
              "addresses": {
                "description": "Addresses configured on this port.",
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/UserSpecifiedUplinkAddressConfig"
                }
              },
              "autoneg": {
                "description": "Whether autonegotiation is enabled.",
                "type": "boolean"
              },
              "bgp_peers": {
                "description": "BGP peers reachable on this port.",
                "default": [],
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/UserSpecifiedBgpPeerConfig"
                }
              },
              "kind": {
                "type": "string",
                "enum": [
                  "uplink"
                ]
              },
              "lldp": {
                "nullable": true,
                "description": "LLDP configuration for this port.",
                "default": null,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/LldpPortConfig"
                  }
                ]
              },
              "routes": {
                "description": "Static routes for this port.",
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RouteConfig"
                }
              },
              "tx_eq": {
                "nullable": true,
                "description": "Transmit equalization overrides for this port.",
                "default": null,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/TxEqConfig"
                  }
                ]
              },
              "uplink_port_fec": {
                "nullable": true,
                "description": "The forward error correction mode, if any.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/LinkFec"
                  }
                ]
              },
              "uplink_port_speed": {
                "description": "The port speed.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/LinkSpeed"
                  }
                ]
              }
            },
            "required": [
              "addresses",
              "autoneg",
              "kind",
              "routes",
              "uplink_port_speed"
            ]
          },
          {
            "description": "A front port running DDM for multirack",
            "type": "object",
            "properties": {
              "autoneg": {
                "description": "Whether autonegotiation is enabled.",
                "type": "boolean"
              },
              "fec": {
                "nullable": true,
                "description": "The forward error correction mode, if any.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/LinkFec"
                  }
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "ddm"
                ]
              },
              "lldp": {
                "nullable": true,
                "description": "LLDP configuration for this port.",
                "default": null,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/LldpPortConfig"
                  }
                ]
              },
              "speed": {
                "description": "The port speed.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/LinkSpeed"
                  }
                ]
              },
              "tx_eq": {
                "nullable": true,
                "description": "Transmit equalization overrides for this port.",
                "default": null,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/TxEqConfig"
                  }
                ]
              }
            },
            "required": [
              "autoneg",
              "kind",
              "speed"
            ]
          }
        ]
      },
      "UserSpecifiedRackNetworkConfig": {
        "description": "User-specified parts of the rack network configuration.",
        "type": "object",
        "properties": {
          "bgp": {
            "description": "BGP configuration for the rack.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BgpConfig"
            }
          },
          "infra_ip_first": {
            "description": "The first address of the infrastructure IP range.",
            "type": "string",
            "format": "ip"
          },
          "infra_ip_last": {
            "description": "The last address of the infrastructure IP range.",
            "type": "string",
            "format": "ip"
          },
          "rack_subnet_address": {
            "nullable": true,
            "description": "The rack subnet address, if statically assigned.",
            "type": "string",
            "format": "ipv6"
          },
          "switch0": {
            "description": "Per-port configuration for switch 0, keyed by port name.",
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/UserSpecifiedPortConfig"
            }
          },
          "switch1": {
            "description": "Per-port configuration for switch 1, keyed by port name.",
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/UserSpecifiedPortConfig"
            }
          }
        },
        "required": [
          "bgp",
          "infra_ip_first",
          "infra_ip_last",
          "switch0",
          "switch1"
        ],
        "additionalProperties": false
      },
      "UserSpecifiedRouterPeerAddr": {
        "type": "string"
      },
      "UserSpecifiedUplinkAddressConfig": {
        "description": "A user-specified uplink address configuration.\n\nThis provides a friendlier TOML representation of an uplink address.",
        "type": "object",
        "properties": {
          "address": {
            "description": "The address to be used on the uplink.",
            "type": "string"
          },
          "vlan_id": {
            "nullable": true,
            "description": "The VLAN id (if any) associated with this address.",
            "default": null,
            "type": "integer",
            "format": "uint16",
            "minimum": 0
          }
        },
        "required": [
          "address"
        ],
        "additionalProperties": false
      },
      "Vendor": {
        "description": "Vendor-specific information about a transceiver module.",
        "type": "object",
        "properties": {
          "date": {
            "nullable": true,
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "oui": {
            "$ref": "#/components/schemas/Oui"
          },
          "part": {
            "type": "string"
          },
          "revision": {
            "type": "string"
          },
          "serial": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "oui",
          "part",
          "revision",
          "serial"
        ]
      },
      "VendorInfo": {
        "description": "The vendor information for a transceiver module.",
        "type": "object",
        "properties": {
          "identifier": {
            "description": "The SFF-8024 identifier.",
            "type": "string"
          },
          "vendor": {
            "description": "The vendor information.",
            "allOf": [
              {
                "$ref": "#/components/schemas/Vendor"
              }
            ]
          }
        },
        "required": [
          "identifier",
          "vendor"
        ]
      },
      "IgnitionCommand": {
        "description": "Ignition command.",
        "type": "string",
        "enum": [
          "power_on",
          "power_off",
          "power_reset"
        ]
      }
    },
    "responses": {
      "Error": {
        "description": "Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    }
  }
}