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": "uint32",
              "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": "uint32",
              "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"
          }
        }
      }
    },
    "/location": {
      "get": {
        "summary": "Report the identity of the sled and switch we're currently running on /",
        "description": "connected to.",
        "operationId": "get_location",
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetLocationResponse"
                }
              }
            }
          },
          "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"
          }
        }
      },
      "post": {
        "summary": "Run rack setup.",
        "description": "Will return an error if not all of the rack setup configuration has been populated.",
        "operationId": "post_run_rack_setup",
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TypedUuidForRackInitKind"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      },
      "delete": {
        "summary": "Run rack reset.",
        "operationId": "post_run_rack_reset",
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TypedUuidForRackResetKind"
                }
              }
            }
          },
          "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"
          }
        }
      },
      "put": {
        "summary": "Update (a subset of) the current RSS configuration.",
        "description": "Sensitive values (certificates and password hash) are not set through this endpoint.",
        "operationId": "put_rss_config",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PutRssUserConfigInsensitive"
              }
            }
          },
          "required": true
        },
        "responses": {
          "204": {
            "description": "resource updated"
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      },
      "delete": {
        "summary": "Reset all RSS configuration to their default values.",
        "operationId": "delete_rss_config",
        "responses": {
          "204": {
            "description": "resource updated"
          },
          "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/bgp/auth-key/{key_id}": {
      "put": {
        "summary": "Set the BGP authentication key for a particular key ID.",
        "operationId": "put_bgp_auth_key",
        "parameters": [
          {
            "in": "path",
            "name": "key_id",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/BgpAuthKeyId"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PutBgpAuthKeyBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PutBgpAuthKeyResponse"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    },
    "/rack-setup/config/cert": {
      "post": {
        "summary": "Add an external certificate.",
        "description": "This must be paired with its private key. They may be posted in either order, but one cannot post two certs in a row (or two keys in a row).",
        "operationId": "post_rss_config_cert",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "title": "String",
                "type": "string"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CertificateUploadResponse"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    },
    "/rack-setup/config/key": {
      "post": {
        "summary": "Add the private key of an external certificate.",
        "description": "This must be paired with its certificate. They may be posted in either order, but one cannot post two keys in a row (or two certs in a row).",
        "operationId": "post_rss_config_key",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "title": "String",
                "type": "string"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CertificateUploadResponse"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    },
    "/rack-setup/config/recovery-user-password-hash": {
      "put": {
        "summary": "Update the RSS config recovery silo user password hash.",
        "operationId": "put_rss_config_recovery_user_password_hash",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PutRssRecoveryUserPasswordHash"
              }
            }
          },
          "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"
          }
        }
      }
    },
    "/repository": {
      "put": {
        "summary": "Upload a TUF repository to the server.",
        "description": "At any given time, wicketd will keep at most one TUF repository in memory. Any previously-uploaded repositories will be discarded.",
        "operationId": "put_repository",
        "requestBody": {
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            }
          },
          "required": true
        },
        "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": "uint32",
              "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"
            ]
          }
        ]
      },
      "ArtifactHashId": {
        "description": "A hash-based identifier for an artifact.\n\nSome places, e.g. the installinator, request artifacts by hash rather than by name and version. This type indicates that.",
        "type": "object",
        "properties": {
          "hash": {
            "description": "The hash of the artifact.",
            "type": "string",
            "format": "hex string (32 bytes)"
          },
          "kind": {
            "description": "The kind of artifact this is.",
            "type": "string"
          }
        },
        "required": [
          "hash",
          "kind"
        ]
      },
      "ArtifactId": {
        "description": "An identifier for an artifact.\n\nThe kind is [`ArtifactKind`], indicating that it might represent an artifact whose kind is unknown.",
        "type": "object",
        "properties": {
          "kind": {
            "description": "The kind of artifact this is.",
            "type": "string"
          },
          "name": {
            "description": "The artifact's name.",
            "type": "string"
          },
          "version": {
            "description": "The artifact's version.",
            "allOf": [
              {
                "$ref": "#/components/schemas/SemverVersion"
              }
            ]
          }
        },
        "required": [
          "kind",
          "name",
          "version"
        ]
      },
      "Baseboard": {
        "description": "Describes properties that should uniquely identify a Gimlet.",
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "identifier": {
                "type": "string"
              },
              "model": {
                "type": "string"
              },
              "revision": {
                "type": "integer",
                "format": "uint32",
                "minimum": 0
              },
              "type": {
                "type": "string",
                "enum": [
                  "gimlet"
                ]
              }
            },
            "required": [
              "identifier",
              "model",
              "revision",
              "type"
            ]
          },
          {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "unknown"
                ]
              }
            },
            "required": [
              "type"
            ]
          },
          {
            "type": "object",
            "properties": {
              "identifier": {
                "type": "string"
              },
              "model": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "pc"
                ]
              }
            },
            "required": [
              "identifier",
              "model",
              "type"
            ]
          }
        ]
      },
      "BgpAuthKey": {
        "description": "Describes the actual authentication key to use with a BGP peer.\n\nCurrently, only TCP-MD5 authentication is supported.",
        "oneOf": [
          {
            "description": "TCP-MD5 authentication.",
            "type": "object",
            "properties": {
              "key": {
                "description": "The pre-shared key.",
                "type": "string"
              },
              "kind": {
                "type": "string",
                "enum": [
                  "tcp_md5"
                ]
              }
            },
            "required": [
              "key",
              "kind"
            ]
          }
        ]
      },
      "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.",
                "type": "string",
                "format": "hex string (32 bytes)"
              }
            },
            "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"
          },
          "originate": {
            "description": "The set of prefixes for the BGP router to originate.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Ipv4Net"
            }
          },
          "shaper": {
            "nullable": true,
            "description": "Shaper to apply to outgoing messages.",
            "default": null,
            "type": "string"
          }
        },
        "required": [
          "asn",
          "originate"
        ]
      },
      "BootstrapSledDescription": {
        "type": "object",
        "properties": {
          "baseboard": {
            "$ref": "#/components/schemas/Baseboard"
          },
          "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"
        ]
      },
      "BootstrapSledIp": {
        "type": "object",
        "properties": {
          "baseboard": {
            "$ref": "#/components/schemas/Baseboard"
          },
          "ip": {
            "type": "string",
            "format": "ipv6"
          }
        },
        "required": [
          "baseboard",
          "ip"
        ]
      },
      "BootstrapSledIps": {
        "type": "object",
        "properties": {
          "sleds": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BootstrapSledIp"
            }
          }
        },
        "required": [
          "sleds"
        ]
      },
      "CertificateUploadResponse": {
        "oneOf": [
          {
            "description": "The key has been uploaded, but we're waiting on its corresponding certificate chain.",
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "waiting_on_cert"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "description": "The cert chain has been uploaded, but we're waiting on its corresponding private key.",
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "waiting_on_key"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "description": "A cert chain and its key have been accepted.",
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "cert_key_accepted"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "description": "A cert chain and its key are valid, but have already been uploaded.",
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "cert_key_duplicate_ignored"
                ]
              }
            },
            "required": [
              "status"
            ]
          }
        ]
      },
      "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. Must be non-empty.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SpIdentifier"
            },
            "uniqueItems": true
          }
        },
        "required": [
          "options",
          "targets"
        ]
      },
      "ClearUpdateStateResponse": {
        "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"
        ]
      },
      "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": {
            "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"
          },
          "internal_services_ip_pool_ranges": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IpRange"
            }
          },
          "ntp_servers": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "rack_network_config": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/UserSpecifiedRackNetworkConfig"
              }
            ]
          }
        },
        "required": [
          "bootstrap_sleds",
          "dns_servers",
          "external_dns_ips",
          "external_dns_zone_name",
          "internal_services_ip_pool_ranges",
          "ntp_servers"
        ]
      },
      "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"
        ]
      },
      "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": "A report produced from an [`EventBuffer`](crate::EventBuffer).\n\nRemote reports can be passed into a [`StepContext`](crate::StepContext), in which case they show up as nested events.",
        "type": "object",
        "properties": {
          "last_seen": {
            "nullable": true,
            "description": "The last event seen.\n\n`last_seen` can be used to retrieve deltas of events.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          },
          "progress_events": {
            "description": "A list of progress events, or whether we're currently waiting for a progress event.\n\nCurrently, this produces one progress event for each top-level and nested event in progress.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProgressEventForUplinkPreflightCheckSpec"
            }
          },
          "root_execution_id": {
            "nullable": true,
            "description": "The root execution ID for this report.\n\nEach report has a root execution ID, which ties together all step and progress events. This is always filled out if the list of step events is non-empty.",
            "type": "string",
            "format": "uuid"
          },
          "step_events": {
            "description": "A list of step events.\n\nStep events include success and failure events.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StepEventForUplinkPreflightCheckSpec"
            }
          }
        },
        "required": [
          "progress_events",
          "step_events"
        ]
      },
      "EventReportForWicketdEngineSpec": {
        "description": "A report produced from an [`EventBuffer`](crate::EventBuffer).\n\nRemote reports can be passed into a [`StepContext`](crate::StepContext), in which case they show up as nested events.",
        "type": "object",
        "properties": {
          "last_seen": {
            "nullable": true,
            "description": "The last event seen.\n\n`last_seen` can be used to retrieve deltas of events.",
            "type": "integer",
            "format": "uint",
            "minimum": 0
          },
          "progress_events": {
            "description": "A list of progress events, or whether we're currently waiting for a progress event.\n\nCurrently, this produces one progress event for each top-level and nested event in progress.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProgressEventForWicketdEngineSpec"
            }
          },
          "root_execution_id": {
            "nullable": true,
            "description": "The root execution ID for this report.\n\nEach report has a root execution ID, which ties together all step and progress events. This is always filled out if the list of step events is non-empty.",
            "type": "string",
            "format": "uuid"
          },
          "step_events": {
            "description": "A list of step events.\n\nStep events include success and failure events.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StepEventForWicketdEngineSpec"
            }
          }
        },
        "required": [
          "progress_events",
          "step_events"
        ]
      },
      "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": "Map of artifacts we ingested from the most-recently-uploaded TUF repository to a list of artifacts we're serving over the bootstrap network. In some cases the list of artifacts being served will have length 1 (when we're serving the artifact directly); in other cases the artifact in the TUF repo contains multiple nested artifacts inside it (e.g., RoT artifacts contain both A and B images), and we serve the list of extracted artifacts but not the original combination.\n\nConceptually, this is a `BTreeMap<ArtifactId, Vec<ArtifactHashId>>`, but JSON requires string keys for maps, so we give back a vec of pairs instead.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InstallableArtifacts"
            }
          },
          "event_reports": {
            "type": "object",
            "additionalProperties": {
              "type": "object",
              "additionalProperties": {
                "$ref": "#/components/schemas/EventReportForWicketdEngineSpec"
              }
            }
          },
          "system_version": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/SemverVersion"
              }
            ]
          }
        },
        "required": [
          "artifacts",
          "event_reports"
        ]
      },
      "GetBaseboardResponse": {
        "type": "object",
        "properties": {
          "baseboard": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/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"
                  },
                  "mgs_last_seen": {
                    "$ref": "#/components/schemas/Duration"
                  }
                },
                "required": [
                  "inventory",
                  "mgs_last_seen"
                ]
              },
              "type": {
                "type": "string",
                "enum": [
                  "response"
                ]
              }
            },
            "required": [
              "data",
              "type"
            ]
          },
          {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "unavailable"
                ]
              }
            },
            "required": [
              "type"
            ]
          }
        ]
      },
      "GetLocationResponse": {
        "description": "All the fields of this response are optional, because it's possible we don't know any of them (yet) if MGS has not yet finished discovering its location or (ever) if we're running in a dev environment that doesn't support MGS-location / baseboard mapping.",
        "type": "object",
        "properties": {
          "sled_baseboard": {
            "nullable": true,
            "description": "The baseboard of our sled (where wicketd is running).",
            "allOf": [
              {
                "$ref": "#/components/schemas/Baseboard"
              }
            ]
          },
          "sled_id": {
            "nullable": true,
            "description": "The identity of our sled (where wicketd is running).",
            "allOf": [
              {
                "$ref": "#/components/schemas/SpIdentifier"
              }
            ]
          },
          "switch_baseboard": {
            "nullable": true,
            "description": "The baseboard of the switch our sled is physically connected to.",
            "allOf": [
              {
                "$ref": "#/components/schemas/Baseboard"
              }
            ]
          },
          "switch_id": {
            "nullable": true,
            "description": "The identity of the switch our sled is physically connected to.",
            "allOf": [
              {
                "$ref": "#/components/schemas/SpIdentifier"
              }
            ]
          }
        }
      },
      "InstallableArtifacts": {
        "type": "object",
        "properties": {
          "artifact_id": {
            "$ref": "#/components/schemas/ArtifactId"
          },
          "installable": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ArtifactHashId"
            }
          },
          "sign": {
            "nullable": true,
            "type": "array",
            "items": {
              "type": "integer",
              "format": "uint8",
              "minimum": 0
            }
          }
        },
        "required": [
          "artifact_id",
          "installable"
        ]
      },
      "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"
        ]
      },
      "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"
        ]
      },
      "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
      },
      "NewPasswordHash": {
        "title": "A password hash in PHC string format",
        "description": "Password hashes must be in PHC (Password Hashing Competition) string format.  Passwords must be hashed with Argon2id.  Password hashes may be rejected if the parameters appear not to be secure enough.",
        "type": "string"
      },
      "PortFec": {
        "description": "Switchport FEC options",
        "type": "string",
        "enum": [
          "firecode",
          "none",
          "rs"
        ]
      },
      "PortSpeed": {
        "description": "Switchport Speed options",
        "type": "string",
        "enum": [
          "speed0_g",
          "speed1_g",
          "speed10_g",
          "speed25_g",
          "speed40_g",
          "speed50_g",
          "speed100_g",
          "speed200_g",
          "speed400_g"
        ]
      },
      "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.\n\n<details><summary>JSON schema</summary>\n\n```json { \"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\" ] } ``` </details>",
        "type": "string",
        "enum": [
          "A0",
          "A1",
          "A2"
        ]
      },
      "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.\n\nBoth `current` and `total` are abstract counters. These counters are often a number of bytes. There is no guarantee that the counter won't go back in subsequent events; that can happen e.g. if a fetch happens from multiple peers within a single attempt.",
        "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.",
            "type": "string"
          }
        },
        "required": [
          "current",
          "units"
        ]
      },
      "ProgressEventForGenericSpec": {
        "type": "object",
        "properties": {
          "data": {
            "description": "The kind of event this is.",
            "allOf": [
              {
                "$ref": "#/components/schemas/ProgressEventKindForGenericSpec"
              }
            ]
          },
          "execution_id": {
            "description": "The execution ID.",
            "type": "string",
            "format": "uuid"
          },
          "spec": {
            "description": "The specification that this event belongs to.\n\nThis is typically the name of the type `S` for which `StepSpec` is implemented.\n\nThis can be used with `Self::from_generic` to deserialize generic metadata.",
            "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.",
            "type": "string",
            "format": "uuid"
          },
          "spec": {
            "description": "The specification that this event belongs to.\n\nThis is typically the name of the type `S` for which `StepSpec` is implemented.\n\nThis can be used with `Self::from_generic` to deserialize generic metadata.",
            "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.",
            "type": "string",
            "format": "uuid"
          },
          "spec": {
            "description": "The specification that this event belongs to.\n\nThis is typically the name of the type `S` for which `StepSpec` is implemented.\n\nThis can be used with `Self::from_generic` to deserialize generic metadata.",
            "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"
            ]
          }
        ]
      },
      "PutBgpAuthKeyBody": {
        "type": "object",
        "properties": {
          "key": {
            "$ref": "#/components/schemas/BgpAuthKey"
          }
        },
        "required": [
          "key"
        ]
      },
      "PutBgpAuthKeyResponse": {
        "type": "object",
        "properties": {
          "status": {
            "$ref": "#/components/schemas/SetBgpAuthKeyStatus"
          }
        },
        "required": [
          "status"
        ]
      },
      "PutRssRecoveryUserPasswordHash": {
        "type": "object",
        "properties": {
          "hash": {
            "$ref": "#/components/schemas/NewPasswordHash"
          }
        },
        "required": [
          "hash"
        ]
      },
      "PutRssUserConfigInsensitive": {
        "description": "The portion of `CurrentRssUserConfig` that can be posted in one shot; it is provided by the wicket user uploading a TOML file, currently.\n\nThis is the \"write\" version of [`CurrentRssUserConfigInsensitive`], with some different fields.",
        "type": "object",
        "properties": {
          "allowed_source_ips": {
            "$ref": "#/components/schemas/AllowedSourceIps"
          },
          "bootstrap_sleds": {
            "description": "List of slot numbers only.\n\n`wicketd` will map this back to sleds with the correct `SpIdentifier` based on the `bootstrap_sleds` it provides in `CurrentRssUserConfigInsensitive`.",
            "type": "array",
            "items": {
              "type": "integer",
              "format": "uint32",
              "minimum": 0
            },
            "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"
          },
          "internal_services_ip_pool_ranges": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IpRange"
            }
          },
          "ntp_servers": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "rack_network_config": {
            "$ref": "#/components/schemas/UserSpecifiedRackNetworkConfig"
          }
        },
        "required": [
          "allowed_source_ips",
          "bootstrap_sleds",
          "dns_servers",
          "external_dns_ips",
          "external_dns_zone_name",
          "internal_services_ip_pool_ranges",
          "ntp_servers",
          "rack_network_config"
        ]
      },
      "RackOperationStatus": {
        "description": "Current status of any rack-level operation being performed by this bootstrap agent.\n\n<details><summary>JSON schema</summary>\n\n```json { \"description\": \"Current status of any rack-level operation being performed by this bootstrap agent.\", \"oneOf\": [ { \"type\": \"object\", \"required\": [ \"id\", \"status\", \"step\" ], \"properties\": { \"id\": { \"$ref\": \"#/components/schemas/TypedUuidForRackInitKind\" }, \"status\": { \"type\": \"string\", \"enum\": [ \"initializing\" ] }, \"step\": { \"$ref\": \"#/components/schemas/RssStep\" } } }, { \"description\": \"`id` will be none if the rack was already initialized on startup.\", \"type\": \"object\", \"required\": [ \"status\" ], \"properties\": { \"id\": { \"allOf\": [ { \"$ref\": \"#/components/schemas/TypedUuidForRackInitKind\" } ] }, \"status\": { \"type\": \"string\", \"enum\": [ \"initialized\" ] } } }, { \"type\": \"object\", \"required\": [ \"id\", \"message\", \"status\" ], \"properties\": { \"id\": { \"$ref\": \"#/components/schemas/TypedUuidForRackInitKind\" }, \"message\": { \"type\": \"string\" }, \"status\": { \"type\": \"string\", \"enum\": [ \"initialization_failed\" ] } } }, { \"type\": \"object\", \"required\": [ \"id\", \"status\" ], \"properties\": { \"id\": { \"$ref\": \"#/components/schemas/TypedUuidForRackInitKind\" }, \"status\": { \"type\": \"string\", \"enum\": [ \"initialization_panicked\" ] } } }, { \"type\": \"object\", \"required\": [ \"id\", \"status\" ], \"properties\": { \"id\": { \"$ref\": \"#/components/schemas/TypedUuidForRackResetKind\" }, \"status\": { \"type\": \"string\", \"enum\": [ \"resetting\" ] } } }, { \"description\": \"`reset_id` will be None if the rack is in an uninitialized-on-startup, or Some if it is in an uninitialized state due to a reset operation completing.\", \"type\": \"object\", \"required\": [ \"status\" ], \"properties\": { \"reset_id\": { \"allOf\": [ { \"$ref\": \"#/components/schemas/TypedUuidForRackResetKind\" } ] }, \"status\": { \"type\": \"string\", \"enum\": [ \"uninitialized\" ] } } }, { \"type\": \"object\", \"required\": [ \"id\", \"message\", \"status\" ], \"properties\": { \"id\": { \"$ref\": \"#/components/schemas/TypedUuidForRackResetKind\" }, \"message\": { \"type\": \"string\" }, \"status\": { \"type\": \"string\", \"enum\": [ \"reset_failed\" ] } } }, { \"type\": \"object\", \"required\": [ \"id\", \"status\" ], \"properties\": { \"id\": { \"$ref\": \"#/components/schemas/TypedUuidForRackResetKind\" }, \"status\": { \"type\": \"string\", \"enum\": [ \"reset_panicked\" ] } } } ] } ``` </details>",
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "$ref": "#/components/schemas/TypedUuidForRackInitKind"
              },
              "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/TypedUuidForRackInitKind"
                  }
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "initialized"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "$ref": "#/components/schemas/TypedUuidForRackInitKind"
              },
              "message": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "initialization_failed"
                ]
              }
            },
            "required": [
              "id",
              "message",
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "$ref": "#/components/schemas/TypedUuidForRackInitKind"
              },
              "status": {
                "type": "string",
                "enum": [
                  "initialization_panicked"
                ]
              }
            },
            "required": [
              "id",
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "$ref": "#/components/schemas/TypedUuidForRackResetKind"
              },
              "status": {
                "type": "string",
                "enum": [
                  "resetting"
                ]
              }
            },
            "required": [
              "id",
              "status"
            ]
          },
          {
            "description": "`reset_id` will be None if the rack is in an uninitialized-on-startup, or Some if it is in an uninitialized state due to a reset operation completing.",
            "type": "object",
            "properties": {
              "reset_id": {
                "nullable": true,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/TypedUuidForRackResetKind"
                  }
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "uninitialized"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "$ref": "#/components/schemas/TypedUuidForRackResetKind"
              },
              "message": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "reset_failed"
                ]
              }
            },
            "required": [
              "id",
              "message",
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "$ref": "#/components/schemas/TypedUuidForRackResetKind"
              },
              "status": {
                "type": "string",
                "enum": [
                  "reset_panicked"
                ]
              }
            },
            "required": [
              "id",
              "status"
            ]
          }
        ]
      },
      "RackV1Inventory": {
        "description": "The current state of the v1 Rack as known to wicketd",
        "type": "object",
        "properties": {
          "sps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SpInventory"
            }
          }
        },
        "required": [
          "sps"
        ]
      },
      "RotImageError": {
        "description": "RotImageError\n\n<details><summary>JSON schema</summary>\n\n```json { \"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\" ] } ``` </details>",
        "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": {
        "description": "RotSlot\n\n<details><summary>JSON schema</summary>\n\n```json { \"oneOf\": [ { \"type\": \"object\", \"required\": [ \"slot\" ], \"properties\": { \"slot\": { \"type\": \"string\", \"enum\": [ \"a\" ] } } }, { \"type\": \"object\", \"required\": [ \"slot\" ], \"properties\": { \"slot\": { \"type\": \"string\", \"enum\": [ \"b\" ] } } } ] } ``` </details>",
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "slot": {
                "type": "string",
                "enum": [
                  "a"
                ]
              }
            },
            "required": [
              "slot"
            ]
          },
          {
            "type": "object",
            "properties": {
              "slot": {
                "type": "string",
                "enum": [
                  "b"
                ]
              }
            },
            "required": [
              "slot"
            ]
          }
        ]
      },
      "RotState": {
        "description": "RotState\n\n<details><summary>JSON schema</summary>\n\n```json { \"oneOf\": [ { \"type\": \"object\", \"required\": [ \"active\", \"persistent_boot_preference\", \"state\" ], \"properties\": { \"active\": { \"$ref\": \"#/components/schemas/RotSlot\" }, \"pending_persistent_boot_preference\": { \"allOf\": [ { \"$ref\": \"#/components/schemas/RotSlot\" } ] }, \"persistent_boot_preference\": { \"$ref\": \"#/components/schemas/RotSlot\" }, \"slot_a_sha3_256_digest\": { \"type\": [ \"string\", \"null\" ] }, \"slot_b_sha3_256_digest\": { \"type\": [ \"string\", \"null\" ] }, \"state\": { \"type\": \"string\", \"enum\": [ \"v2\" ] }, \"transient_boot_preference\": { \"allOf\": [ { \"$ref\": \"#/components/schemas/RotSlot\" } ] } } }, { \"type\": \"object\", \"required\": [ \"message\", \"state\" ], \"properties\": { \"message\": { \"type\": \"string\" }, \"state\": { \"type\": \"string\", \"enum\": [ \"communication_failed\" ] } } }, { \"type\": \"object\", \"required\": [ \"active\", \"persistent_boot_preference\", \"slot_a_fwid\", \"slot_b_fwid\", \"stage0_fwid\", \"stage0next_fwid\", \"state\" ], \"properties\": { \"active\": { \"$ref\": \"#/components/schemas/RotSlot\" }, \"pending_persistent_boot_preference\": { \"allOf\": [ { \"$ref\": \"#/components/schemas/RotSlot\" } ] }, \"persistent_boot_preference\": { \"$ref\": \"#/components/schemas/RotSlot\" }, \"slot_a_error\": { \"allOf\": [ { \"$ref\": \"#/components/schemas/RotImageError\" } ] }, \"slot_a_fwid\": { \"type\": \"string\" }, \"slot_b_error\": { \"allOf\": [ { \"$ref\": \"#/components/schemas/RotImageError\" } ] }, \"slot_b_fwid\": { \"type\": \"string\" }, \"stage0_error\": { \"allOf\": [ { \"$ref\": \"#/components/schemas/RotImageError\" } ] }, \"stage0_fwid\": { \"type\": \"string\" }, \"stage0next_error\": { \"allOf\": [ { \"$ref\": \"#/components/schemas/RotImageError\" } ] }, \"stage0next_fwid\": { \"type\": \"string\" }, \"state\": { \"type\": \"string\", \"enum\": [ \"v3\" ] }, \"transient_boot_preference\": { \"allOf\": [ { \"$ref\": \"#/components/schemas/RotSlot\" } ] } } } ] } ``` </details>",
        "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"
        ]
      },
      "RssStep": {
        "description": "Steps we go through during initial rack setup. Keep this list in order that they happen.\n\n<details><summary>JSON schema</summary>\n\n```json { \"description\": \"Steps we go through during initial rack setup. Keep this list in order that they happen.\", \"oneOf\": [ { \"type\": \"object\", \"required\": [ \"status\" ], \"properties\": { \"status\": { \"type\": \"string\", \"enum\": [ \"requested\" ] } } }, { \"type\": \"object\", \"required\": [ \"status\" ], \"properties\": { \"status\": { \"type\": \"string\", \"enum\": [ \"starting\" ] } } }, { \"type\": \"object\", \"required\": [ \"status\" ], \"properties\": { \"status\": { \"type\": \"string\", \"enum\": [ \"load_existing_plan\" ] } } }, { \"type\": \"object\", \"required\": [ \"status\" ], \"properties\": { \"status\": { \"type\": \"string\", \"enum\": [ \"create_sled_plan\" ] } } }, { \"type\": \"object\", \"required\": [ \"status\" ], \"properties\": { \"status\": { \"type\": \"string\", \"enum\": [ \"init_trust_quorum\" ] } } }, { \"type\": \"object\", \"required\": [ \"status\" ], \"properties\": { \"status\": { \"type\": \"string\", \"enum\": [ \"network_config_update\" ] } } }, { \"type\": \"object\", \"required\": [ \"status\" ], \"properties\": { \"status\": { \"type\": \"string\", \"enum\": [ \"sled_init\" ] } } }, { \"type\": \"object\", \"required\": [ \"status\" ], \"properties\": { \"status\": { \"type\": \"string\", \"enum\": [ \"ensure_storage\" ] } } }, { \"type\": \"object\", \"required\": [ \"status\" ], \"properties\": { \"status\": { \"type\": \"string\", \"enum\": [ \"init_dns\" ] } } }, { \"type\": \"object\", \"required\": [ \"status\" ], \"properties\": { \"status\": { \"type\": \"string\", \"enum\": [ \"configure_dns\" ] } } }, { \"type\": \"object\", \"required\": [ \"status\" ], \"properties\": { \"status\": { \"type\": \"string\", \"enum\": [ \"init_ntp\" ] } } }, { \"type\": \"object\", \"required\": [ \"status\" ], \"properties\": { \"status\": { \"type\": \"string\", \"enum\": [ \"wait_for_time_sync\" ] } } }, { \"type\": \"object\", \"required\": [ \"status\" ], \"properties\": { \"status\": { \"type\": \"string\", \"enum\": [ \"wait_for_database\" ] } } }, { \"type\": \"object\", \"required\": [ \"status\" ], \"properties\": { \"status\": { \"type\": \"string\", \"enum\": [ \"cluster_init\" ] } } }, { \"type\": \"object\", \"required\": [ \"status\" ], \"properties\": { \"status\": { \"type\": \"string\", \"enum\": [ \"zones_init\" ] } } }, { \"type\": \"object\", \"required\": [ \"status\" ], \"properties\": { \"status\": { \"type\": \"string\", \"enum\": [ \"nexus_handoff\" ] } } } ] } ``` </details>",
        "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": [
                  "network_config_update"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "sled_init"
                ]
              }
            },
            "required": [
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "ensure_storage"
                ]
              }
            },
            "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"
            ]
          }
        ]
      },
      "SemverVersion": {
        "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-]+)*))?$"
      },
      "SetBgpAuthKeyStatus": {
        "oneOf": [
          {
            "description": "The key was accepted and replaced an old key.",
            "type": "string",
            "enum": [
              "replaced"
            ]
          },
          {
            "description": "The key was accepted, and is the same as the existing key.",
            "type": "string",
            "enum": [
              "unchanged"
            ]
          },
          {
            "description": "The key was accepted and is new.",
            "type": "string",
            "enum": [
              "added"
            ]
          }
        ]
      },
      "SpComponentCaboose": {
        "description": "SpComponentCaboose\n\n<details><summary>JSON schema</summary>\n\n```json { \"type\": \"object\", \"required\": [ \"board\", \"git_commit\", \"name\", \"version\" ], \"properties\": { \"board\": { \"type\": \"string\" }, \"epoch\": { \"type\": [ \"string\", \"null\" ] }, \"git_commit\": { \"type\": \"string\" }, \"name\": { \"type\": \"string\" }, \"sign\": { \"type\": [ \"string\", \"null\" ] }, \"version\": { \"type\": \"string\" } } } ``` </details>",
        "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.\n\n<details><summary>JSON schema</summary>\n\n```json { \"description\": \"Overview of a single SP component.\", \"type\": \"object\", \"required\": [ \"capabilities\", \"component\", \"description\", \"device\", \"presence\" ], \"properties\": { \"capabilities\": { \"description\": \"`capabilities` is a bitmask; interpret it via [`gateway_messages::DeviceCapabilities`].\", \"type\": \"integer\", \"format\": \"uint32\", \"minimum\": 0.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\": { \"description\": \"The component's serial number, if it has one.\", \"type\": [ \"string\", \"null\" ] } } } ``` </details>",
        "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).\n\n<details><summary>JSON schema</summary>\n\n```json { \"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\" ] } ] } ``` </details>",
        "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"
            ]
          }
        ]
      },
      "SpIdentifier": {
        "description": "SpIdentifier\n\n<details><summary>JSON schema</summary>\n\n```json { \"type\": \"object\", \"required\": [ \"slot\", \"type\" ], \"properties\": { \"slot\": { \"type\": \"integer\", \"format\": \"uint32\", \"minimum\": 0.0 }, \"type\": { \"$ref\": \"#/components/schemas/SpType\" } } } ``` </details>",
        "type": "object",
        "properties": {
          "slot": {
            "type": "integer",
            "format": "uint32",
            "minimum": 0
          },
          "type": {
            "$ref": "#/components/schemas/SpType"
          }
        },
        "required": [
          "slot",
          "type"
        ]
      },
      "SpIgnition": {
        "description": "State of an ignition target.\n\nTODO: Ignition returns much more information than we're reporting here: do we want to expand this?\n\n<details><summary>JSON schema</summary>\n\n```json { \"description\": \"State of an ignition target.\\n\\nTODO: Ignition returns much more information than we're reporting here: do we want to expand this?\", \"oneOf\": [ { \"type\": \"object\", \"required\": [ \"present\" ], \"properties\": { \"present\": { \"type\": \"string\", \"enum\": [ \"no\" ] } } }, { \"type\": \"object\", \"required\": [ \"ctrl_detect_0\", \"ctrl_detect_1\", \"flt_a2\", \"flt_a3\", \"flt_rot\", \"flt_sp\", \"id\", \"power\", \"present\" ], \"properties\": { \"ctrl_detect_0\": { \"type\": \"boolean\" }, \"ctrl_detect_1\": { \"type\": \"boolean\" }, \"flt_a2\": { \"type\": \"boolean\" }, \"flt_a3\": { \"type\": \"boolean\" }, \"flt_rot\": { \"type\": \"boolean\" }, \"flt_sp\": { \"type\": \"boolean\" }, \"id\": { \"$ref\": \"#/components/schemas/SpIgnitionSystemType\" }, \"power\": { \"type\": \"boolean\" }, \"present\": { \"type\": \"string\", \"enum\": [ \"yes\" ] } } } ] } ``` </details>",
        "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": {
                "type": "boolean"
              },
              "flt_a3": {
                "type": "boolean"
              },
              "flt_rot": {
                "type": "boolean"
              },
              "flt_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": {
        "description": "TODO: Do we want to bake in specific board names, or use raw u16 ID numbers?\n\n<details><summary>JSON schema</summary>\n\n```json { \"description\": \"TODO: Do we want to bake in specific board names, or use raw u16 ID numbers?\", \"oneOf\": [ { \"type\": \"object\", \"required\": [ \"system_type\" ], \"properties\": { \"system_type\": { \"type\": \"string\", \"enum\": [ \"gimlet\" ] } } }, { \"type\": \"object\", \"required\": [ \"system_type\" ], \"properties\": { \"system_type\": { \"type\": \"string\", \"enum\": [ \"sidecar\" ] } } }, { \"type\": \"object\", \"required\": [ \"system_type\" ], \"properties\": { \"system_type\": { \"type\": \"string\", \"enum\": [ \"psc\" ] } } }, { \"type\": \"object\", \"required\": [ \"id\", \"system_type\" ], \"properties\": { \"id\": { \"type\": \"integer\", \"format\": \"uint16\", \"minimum\": 0.0 }, \"system_type\": { \"type\": \"string\", \"enum\": [ \"unknown\" ] } } } ] } ``` </details>",
        "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"
            ]
          }
        ]
      },
      "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": {
        "description": "SpState\n\n<details><summary>JSON schema</summary>\n\n```json { \"type\": \"object\", \"required\": [ \"base_mac_address\", \"hubris_archive_id\", \"model\", \"power_state\", \"revision\", \"rot\", \"serial_number\" ], \"properties\": { \"base_mac_address\": { \"type\": \"array\", \"items\": { \"type\": \"integer\", \"format\": \"uint8\", \"minimum\": 0.0 }, \"maxItems\": 6, \"minItems\": 6 }, \"hubris_archive_id\": { \"type\": \"string\" }, \"model\": { \"type\": \"string\" }, \"power_state\": { \"$ref\": \"#/components/schemas/PowerState\" }, \"revision\": { \"type\": \"integer\", \"format\": \"uint32\", \"minimum\": 0.0 }, \"rot\": { \"$ref\": \"#/components/schemas/RotState\" }, \"serial_number\": { \"type\": \"string\" } } } ``` </details>",
        "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/PowerState"
          },
          "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": {
        "description": "SpType\n\n<details><summary>JSON schema</summary>\n\n```json { \"type\": \"string\", \"enum\": [ \"sled\", \"power\", \"switch\" ] } ``` </details>",
        "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. Must be non-empty.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SpIdentifier"
            },
            "uniqueItems": true
          }
        },
        "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": {
        "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.",
            "type": "string",
            "format": "uuid"
          },
          "spec": {
            "description": "The specification that this event belongs to.\n\nThis is typically the name of the type `S` for which `StepSpec` is implemented.\n\nThis can be used along with `Self::from_generic` to identify which specification to deserialize generic metadata against. For example:\n\n```rust,ignore if event.spec == \"MySpec\" { // event is likely generated from a MySpec engine. let event = Event::<MySpec>::from_generic(event)?; // ... } ```",
            "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.",
            "type": "string",
            "format": "uuid"
          },
          "spec": {
            "description": "The specification that this event belongs to.\n\nThis is typically the name of the type `S` for which `StepSpec` is implemented.\n\nThis can be used along with `Self::from_generic` to identify which specification to deserialize generic metadata against. For example:\n\n```rust,ignore if event.spec == \"MySpec\" { // event is likely generated from a MySpec engine. let event = Event::<MySpec>::from_generic(event)?; // ... } ```",
            "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.",
            "type": "string",
            "format": "uuid"
          },
          "spec": {
            "description": "The specification that this event belongs to.\n\nThis is typically the name of the type `S` for which `StepSpec` is implemented.\n\nThis can be used along with `Self::from_generic` to identify which specification to deserialize generic metadata against. For example:\n\n```rust,ignore if event.spec == \"MySpec\" { // event is likely generated from a MySpec engine. let event = Event::<MySpec>::from_generic(event)?; // ... } ```",
            "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 assocaited 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 assocaited 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 assocaited 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"
            ]
          }
        ]
      },
      "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"
          }
        }
      },
      "TypedUuidForRackInitKind": {
        "type": "string",
        "format": "uuid"
      },
      "TypedUuidForRackResetKind": {
        "type": "string",
        "format": "uuid"
      },
      "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": [
                  "downloading_installinator"
                ]
              }
            },
            "required": [
              "id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "running_installinator"
                ]
              }
            },
            "required": [
              "id"
            ]
          }
        ]
      },
      "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"
            ]
          }
        ]
      },
      "UplinkAddressConfig": {
        "type": "object",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/IpNet"
          },
          "vlan_id": {
            "nullable": true,
            "description": "The VLAN id (if any) associated with this address.",
            "default": null,
            "type": "integer",
            "format": "uint16",
            "minimum": 0
          }
        },
        "required": [
          "address"
        ]
      },
      "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 version of [`BgpPeerConfig`].\n\nThis is similar to [`BgpPeerConfig`], except it doesn't have the sensitive `md5_auth_key` parameter, instead requiring that the user provide the key separately.\n\n[`BgpPeerConfig`]: omicron_common::api::internal::shared::BgpPeerConfig",
        "type": "object",
        "properties": {
          "addr": {
            "description": "Address of the peer.",
            "type": "string",
            "format": "ipv4"
          },
          "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 sysetm 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
          },
          "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": "User-specified version of [`PortConfigV2`].\n\nAll of [`PortConfigV2`] is user-specified. But we expect the port name to be a key, rather than a field as in [`PortConfigV2`]. So this has all of the fields other than the port name.\n\n[`PortConfigV2`]: omicron_common::api::internal::shared::PortConfigV2",
        "type": "object",
        "properties": {
          "addresses": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UplinkAddressConfig"
            }
          },
          "autoneg": {
            "type": "boolean"
          },
          "bgp_peers": {
            "default": [],
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UserSpecifiedBgpPeerConfig"
            }
          },
          "lldp": {
            "nullable": true,
            "default": null,
            "allOf": [
              {
                "$ref": "#/components/schemas/LldpPortConfig"
              }
            ]
          },
          "routes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RouteConfig"
            }
          },
          "tx_eq": {
            "nullable": true,
            "default": null,
            "allOf": [
              {
                "$ref": "#/components/schemas/TxEqConfig"
              }
            ]
          },
          "uplink_port_fec": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/PortFec"
              }
            ]
          },
          "uplink_port_speed": {
            "$ref": "#/components/schemas/PortSpeed"
          }
        },
        "required": [
          "addresses",
          "autoneg",
          "routes",
          "uplink_port_speed"
        ],
        "additionalProperties": false
      },
      "UserSpecifiedRackNetworkConfig": {
        "description": "User-specified parts of [`RackNetworkConfig`](omicron_common::api::internal::shared::RackNetworkConfig).",
        "type": "object",
        "properties": {
          "bgp": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BgpConfig"
            }
          },
          "infra_ip_first": {
            "type": "string",
            "format": "ipv4"
          },
          "infra_ip_last": {
            "type": "string",
            "format": "ipv4"
          },
          "switch0": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/UserSpecifiedPortConfig"
            }
          },
          "switch1": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/UserSpecifiedPortConfig"
            }
          }
        },
        "required": [
          "bgp",
          "infra_ip_first",
          "infra_ip_last",
          "switch0",
          "switch1"
        ],
        "additionalProperties": false
      },
      "IgnitionCommand": {
        "description": "Ignition command.\n\n<details><summary>JSON schema</summary>\n\n```json { \"description\": \"Ignition command.\", \"type\": \"string\", \"enum\": [ \"power_on\", \"power_off\", \"power_reset\" ] } ``` </details>",
        "type": "string",
        "enum": [
          "power_on",
          "power_off",
          "power_reset"
        ]
      }
    },
    "responses": {
      "Error": {
        "description": "Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    }
  }
}