metal-api.json

{
  "basePath": "/",
  "definitions": {
    "datastore.IPSearchQuery": {
      "description": "an ip address that can be attached to a machine",
      "properties": {
        "allocationuuid": {
          "description": "a unique identifier for this ip address allocation, can be used to distinguish between ip address allocation over time.",
          "type": "string"
        },
        "ipaddress": {
          "description": "the address (ipv4 or ipv6) of this ip",
          "type": "string"
        },
        "machineid": {
          "description": "the machine an ip address is associated to",
          "type": "string"
        },
        "name": {
          "description": "the name of the ip address",
          "type": "string"
        },
        "networkid": {
          "description": "the network this ip allocate request address belongs to",
          "type": "string"
        },
        "networkprefix": {
          "description": "the prefix of the network this ip address belongs to",
          "type": "string"
        },
        "projectid": {
          "description": "the project this ip address belongs to, empty if not strong coupled",
          "type": "string"
        },
        "tags": {
          "description": "the tags that are assigned to this ip address",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "type": {
          "description": "the type of the ip address, ephemeral or static",
          "type": "string"
        }
      }
    },
    "datastore.ImageSearchQuery": {
      "properties": {
        "classification": {
          "enum": [
            "deprecated",
            "preview",
            "supported"
          ],
          "type": "string"
        },
        "features": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "os": {
          "type": "string"
        },
        "version": {
          "type": "string"
        }
      }
    },
    "datastore.MachineSearchQuery": {
      "properties": {
        "allocation_hostname": {
          "type": "string"
        },
        "allocation_image_id": {
          "type": "string"
        },
        "allocation_name": {
          "type": "string"
        },
        "allocation_project": {
          "type": "string"
        },
        "allocation_role": {
          "type": "string"
        },
        "allocation_succeeded": {
          "type": "boolean"
        },
        "disk_names": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "disk_sizes": {
          "items": {
            "format": "int64",
            "type": "integer"
          },
          "type": "array"
        },
        "fru_board_mfg": {
          "type": "string"
        },
        "fru_board_mfg_serial": {
          "type": "string"
        },
        "fru_board_part_number": {
          "type": "string"
        },
        "fru_chassis_part_number": {
          "type": "string"
        },
        "fru_chassis_part_serial": {
          "type": "string"
        },
        "fru_product_manufacturer": {
          "type": "string"
        },
        "fru_product_part_number": {
          "type": "string"
        },
        "fru_product_serial": {
          "type": "string"
        },
        "hardware_memory": {
          "format": "int64",
          "type": "integer"
        },
        "id": {
          "type": "string"
        },
        "ipmi_address": {
          "type": "string"
        },
        "ipmi_interface": {
          "type": "string"
        },
        "ipmi_mac_address": {
          "type": "string"
        },
        "ipmi_user": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "network_asns": {
          "items": {
            "format": "int64",
            "type": "integer"
          },
          "type": "array"
        },
        "network_destination_prefixes": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "network_ids": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "network_ips": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "network_prefixes": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "network_vrfs": {
          "items": {
            "format": "int64",
            "type": "integer"
          },
          "type": "array"
        },
        "nics_mac_addresses": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_names": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_neighbor_mac_addresses": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_neighbor_names": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_neighbor_vrfs": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_vrfs": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "partition_id": {
          "type": "string"
        },
        "rackid": {
          "type": "string"
        },
        "sizeid": {
          "type": "string"
        },
        "state_value": {
          "enum": [
            "",
            "LOCKED",
            "RESERVED"
          ],
          "type": "string"
        },
        "tags": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      }
    },
    "datastore.NetworkSearchQuery": {
      "properties": {
        "destinationprefixes": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "id": {
          "type": "string"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        "name": {
          "type": "string"
        },
        "nat": {
          "type": "boolean"
        },
        "parentnetworkid": {
          "type": "string"
        },
        "partitionid": {
          "type": "string"
        },
        "prefixes": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "privatesuper": {
          "type": "boolean"
        },
        "projectid": {
          "type": "string"
        },
        "underlay": {
          "type": "boolean"
        },
        "vrf": {
          "format": "int64",
          "type": "integer"
        }
      }
    },
    "datastore.SwitchSearchQuery": {
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "osvendor": {
          "type": "string"
        },
        "osversion": {
          "type": "string"
        },
        "partitionid": {
          "type": "string"
        },
        "rackid": {
          "type": "string"
        }
      }
    },
    "httperrors.HTTPErrorResponse": {
      "properties": {
        "message": {
          "description": "error message",
          "type": "string"
        },
        "statuscode": {
          "description": "http status code",
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "message",
        "statuscode"
      ],
      "x-go-type": {
        "import": {
          "package": "github.com/metal-stack/metal-lib/httperrors"
        },
        "type": "HTTPErrorResponse"
      }
    },
    "rest.HealthResponse": {
      "properties": {
        "message": {
          "type": "string"
        },
        "services": {
          "additionalProperties": {
            "$ref": "#/definitions/rest.HealthResponse"
          },
          "type": "object"
        },
        "status": {
          "type": "string"
        }
      },
      "required": [
        "message",
        "status"
      ]
    },
    "rest.version": {
      "properties": {
        "builddate": {
          "type": "string"
        },
        "gitsha1": {
          "type": "string"
        },
        "min_client_version": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "release_version": {
          "type": "string"
        },
        "revision": {
          "type": "string"
        },
        "version": {
          "type": "string"
        }
      },
      "required": [
        "builddate",
        "gitsha1",
        "min_client_version",
        "name",
        "revision",
        "version"
      ]
    },
    "v1.AuditFindRequest": {
      "properties": {
        "body": {
          "type": "string"
        },
        "component": {
          "type": "string"
        },
        "detail": {
          "type": "string"
        },
        "error": {
          "type": "string"
        },
        "forwarded_for": {
          "type": "string"
        },
        "from": {
          "format": "date-time",
          "type": "string"
        },
        "limit": {
          "format": "int64",
          "type": "integer"
        },
        "path": {
          "type": "string"
        },
        "phase": {
          "type": "string"
        },
        "remote_addr": {
          "type": "string"
        },
        "rqid": {
          "type": "string"
        },
        "status_code": {
          "format": "int32",
          "type": "integer"
        },
        "tenant": {
          "type": "string"
        },
        "to": {
          "format": "date-time",
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "user": {
          "type": "string"
        }
      }
    },
    "v1.AuditResponse": {
      "properties": {
        "body": {
          "type": "string"
        },
        "component": {
          "type": "string"
        },
        "detail": {
          "type": "string"
        },
        "error": {
          "type": "string"
        },
        "forwarded_for": {
          "type": "string"
        },
        "path": {
          "type": "string"
        },
        "phase": {
          "type": "string"
        },
        "remote_addr": {
          "type": "string"
        },
        "rqid": {
          "type": "string"
        },
        "status_code": {
          "format": "int32",
          "type": "integer"
        },
        "tenant": {
          "type": "string"
        },
        "timestamp": {
          "format": "date-time",
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "user": {
          "type": "string"
        }
      }
    },
    "v1.BGPFilter": {
      "properties": {
        "cidrs": {
          "description": "the cidr addresses that are allowed to be announced at this switch port",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "vnis": {
          "description": "the virtual networks that are exposed at this switch port",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "cidrs"
      ]
    },
    "v1.BoardRevisions": {
      "properties": {
        "BoardRevisions": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "type": "object"
        }
      },
      "required": [
        "BoardRevisions"
      ]
    },
    "v1.BootInfo": {
      "properties": {
        "bootloaderid": {
          "description": "the bootloader ID",
          "type": "string"
        },
        "cmdline": {
          "description": "the cmdline",
          "type": "string"
        },
        "image_id": {
          "description": "the ID of the current image",
          "type": "string"
        },
        "initrd": {
          "description": "the initrd image",
          "type": "string"
        },
        "kernel": {
          "description": "the kernel",
          "type": "string"
        },
        "os_partition": {
          "description": "the partition containing the OS",
          "type": "string"
        },
        "primary_disk": {
          "description": "the primary disk",
          "type": "string"
        }
      },
      "required": [
        "bootloaderid",
        "cmdline",
        "image_id",
        "initrd",
        "kernel",
        "os_partition",
        "primary_disk"
      ]
    },
    "v1.ChassisIdentifyLEDState": {
      "properties": {
        "description": {
          "description": "a description why this chassis identify LED is in the given state",
          "type": "string"
        },
        "value": {
          "description": "the state of this chassis identify LED. empty means LED-OFF",
          "type": "string"
        }
      },
      "required": [
        "description",
        "value"
      ]
    },
    "v1.Common": {
      "properties": {
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        }
      },
      "required": [
        "id"
      ]
    },
    "v1.Describable": {
      "properties": {
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        }
      }
    },
    "v1.Disk": {
      "properties": {
        "device": {
          "description": "the device to create the partitions",
          "type": "string"
        },
        "partitions": {
          "description": "list of partitions to create on this disk",
          "items": {
            "$ref": "#/definitions/v1.DiskPartition"
          },
          "type": "array"
        },
        "wipeonreinstall": {
          "description": "if set to true, this disk will be wiped before reinstallation",
          "type": "boolean"
        }
      },
      "required": [
        "device",
        "wipeonreinstall"
      ]
    },
    "v1.DiskPartition": {
      "properties": {
        "gpttype": {
          "description": "the gpt partition table type of this partition",
          "type": "string"
        },
        "label": {
          "description": "optional label for this this partition",
          "type": "string"
        },
        "number": {
          "description": "partition number, will be appended to partitionprefix to create the final devicename",
          "format": "byte",
          "type": "integer"
        },
        "size": {
          "description": "size in mebibytes (MiB) of this partition",
          "format": "integer",
          "type": "integer"
        }
      },
      "required": [
        "gpttype",
        "number",
        "size"
      ]
    },
    "v1.EmptyBody": {},
    "v1.Filesystem": {
      "properties": {
        "createoptions": {
          "description": "the options to use to create (mkfs) this filesystem",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "device": {
          "description": "the underlying device where this filesystem should be created",
          "type": "string"
        },
        "format": {
          "description": "the filesystem format",
          "type": "string"
        },
        "label": {
          "description": "optional label for this this filesystem",
          "type": "string"
        },
        "mountoptions": {
          "description": "the options to use to mount this filesystem",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "path": {
          "description": "the mountpoint where this filesystem should be mounted on",
          "type": "string"
        }
      },
      "required": [
        "device",
        "format"
      ]
    },
    "v1.FilesystemLayoutBase": {
      "properties": {
        "constraints": {
          "$ref": "#/definitions/v1.FilesystemLayoutConstraints",
          "description": "constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts"
        },
        "disks": {
          "description": "list of disks that belong to this layout",
          "items": {
            "$ref": "#/definitions/v1.Disk"
          },
          "type": "array"
        },
        "filesystems": {
          "description": "list of filesystems to create",
          "items": {
            "$ref": "#/definitions/v1.Filesystem"
          },
          "type": "array"
        },
        "logicalvolumes": {
          "description": "list of logicalvolumes to create",
          "items": {
            "$ref": "#/definitions/v1.LogicalVolume"
          },
          "type": "array"
        },
        "raid": {
          "description": "list of raid arrays to create",
          "items": {
            "$ref": "#/definitions/v1.Raid"
          },
          "type": "array"
        },
        "volumegroups": {
          "description": "list of volumegroups to create",
          "items": {
            "$ref": "#/definitions/v1.VolumeGroup"
          },
          "type": "array"
        }
      },
      "required": [
        "constraints"
      ]
    },
    "v1.FilesystemLayoutConstraints": {
      "properties": {
        "images": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "list of images this layout applies to",
          "type": "object"
        },
        "sizes": {
          "description": "list of sizes this layout applies to",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "images"
      ]
    },
    "v1.FilesystemLayoutCreateRequest": {
      "properties": {
        "constraints": {
          "$ref": "#/definitions/v1.FilesystemLayoutConstraints",
          "description": "constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "disks": {
          "description": "list of disks that belong to this layout",
          "items": {
            "$ref": "#/definitions/v1.Disk"
          },
          "type": "array"
        },
        "filesystems": {
          "description": "list of filesystems to create",
          "items": {
            "$ref": "#/definitions/v1.Filesystem"
          },
          "type": "array"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "logicalvolumes": {
          "description": "list of logicalvolumes to create",
          "items": {
            "$ref": "#/definitions/v1.LogicalVolume"
          },
          "type": "array"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "raid": {
          "description": "list of raid arrays to create",
          "items": {
            "$ref": "#/definitions/v1.Raid"
          },
          "type": "array"
        },
        "volumegroups": {
          "description": "list of volumegroups to create",
          "items": {
            "$ref": "#/definitions/v1.VolumeGroup"
          },
          "type": "array"
        }
      },
      "required": [
        "constraints",
        "id"
      ]
    },
    "v1.FilesystemLayoutMatchRequest": {
      "properties": {
        "filesystemlayout": {
          "description": "filesystemlayout id to check",
          "type": "string"
        },
        "machine": {
          "description": "machine id to check",
          "type": "string"
        }
      },
      "required": [
        "filesystemlayout",
        "machine"
      ]
    },
    "v1.FilesystemLayoutResponse": {
      "properties": {
        "constraints": {
          "$ref": "#/definitions/v1.FilesystemLayoutConstraints",
          "description": "constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "disks": {
          "description": "list of disks that belong to this layout",
          "items": {
            "$ref": "#/definitions/v1.Disk"
          },
          "type": "array"
        },
        "filesystems": {
          "description": "list of filesystems to create",
          "items": {
            "$ref": "#/definitions/v1.Filesystem"
          },
          "type": "array"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "logicalvolumes": {
          "description": "list of logicalvolumes to create",
          "items": {
            "$ref": "#/definitions/v1.LogicalVolume"
          },
          "type": "array"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "raid": {
          "description": "list of raid arrays to create",
          "items": {
            "$ref": "#/definitions/v1.Raid"
          },
          "type": "array"
        },
        "volumegroups": {
          "description": "list of volumegroups to create",
          "items": {
            "$ref": "#/definitions/v1.VolumeGroup"
          },
          "type": "array"
        }
      },
      "required": [
        "constraints",
        "id"
      ]
    },
    "v1.FilesystemLayoutTryRequest": {
      "properties": {
        "image": {
          "description": "image to try",
          "type": "string"
        },
        "size": {
          "description": "machine size to try",
          "type": "string"
        }
      },
      "required": [
        "image",
        "size"
      ]
    },
    "v1.FilesystemLayoutUpdateRequest": {
      "properties": {
        "constraints": {
          "$ref": "#/definitions/v1.FilesystemLayoutConstraints",
          "description": "constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "disks": {
          "description": "list of disks that belong to this layout",
          "items": {
            "$ref": "#/definitions/v1.Disk"
          },
          "type": "array"
        },
        "filesystems": {
          "description": "list of filesystems to create",
          "items": {
            "$ref": "#/definitions/v1.Filesystem"
          },
          "type": "array"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "logicalvolumes": {
          "description": "list of logicalvolumes to create",
          "items": {
            "$ref": "#/definitions/v1.LogicalVolume"
          },
          "type": "array"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "raid": {
          "description": "list of raid arrays to create",
          "items": {
            "$ref": "#/definitions/v1.Raid"
          },
          "type": "array"
        },
        "volumegroups": {
          "description": "list of volumegroups to create",
          "items": {
            "$ref": "#/definitions/v1.VolumeGroup"
          },
          "type": "array"
        }
      },
      "required": [
        "constraints",
        "id"
      ]
    },
    "v1.FirewallAllocateRequest": {
      "properties": {
        "firewall_rules": {
          "$ref": "#/definitions/v1.FirewallRules",
          "description": "optional egress and ingress firewall rules to deploy during firewall allocation"
        }
      }
    },
    "v1.FirewallCreateRequest": {
      "properties": {
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "filesystemlayoutid": {
          "description": "the filesystemlayout id to assign to this machine",
          "type": "string"
        },
        "firewall_rules": {
          "$ref": "#/definitions/v1.FirewallRules",
          "description": "optional egress and ingress firewall rules to deploy during firewall allocation"
        },
        "hostname": {
          "description": "the hostname for the allocated machine (defaults to metal)",
          "type": "string"
        },
        "imageid": {
          "description": "the image id to assign this machine to",
          "type": "string"
        },
        "ips": {
          "description": "the ips to attach to this machine additionally",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "networks": {
          "description": "the networks that this machine will be placed in.",
          "items": {
            "$ref": "#/definitions/v1.MachineAllocationNetwork"
          },
          "type": "array"
        },
        "partitionid": {
          "description": "the partition id to assign this machine to",
          "type": "string"
        },
        "placement_tags": {
          "description": "by default machines are spread across the racks inside a partition for every project. if placement tags are provided, the machine candidate has an additional anti-affinity to other machines having the same tags",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "projectid": {
          "description": "the project id to assign this machine to",
          "type": "string"
        },
        "sizeid": {
          "description": "the size id to assign this machine to",
          "type": "string"
        },
        "ssh_pub_keys": {
          "description": "the public ssh keys to access the machine with",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "tags": {
          "description": "tags for this machine",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "user_data": {
          "description": "cloud-init.io compatible userdata must be base64 encoded",
          "type": "string"
        },
        "uuid": {
          "description": "if this field is set, this specific machine will be allocated if it is not in available state and not currently allocated. this field overrules size and partition",
          "type": "string"
        }
      },
      "required": [
        "imageid",
        "partitionid",
        "projectid",
        "sizeid",
        "ssh_pub_keys"
      ]
    },
    "v1.FirewallEgressRule": {
      "properties": {
        "comment": {
          "description": "an optional comment describing what this rule is used for",
          "type": "string"
        },
        "ports": {
          "description": "the ports affected by this rule",
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": "array"
        },
        "protocol": {
          "description": "the protocol for the rule, defaults to tcp",
          "enum": [
            "tcp",
            "udp"
          ],
          "type": "string"
        },
        "to": {
          "description": "the cidrs affected by this rule",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "ports",
        "to"
      ]
    },
    "v1.FirewallFindRequest": {
      "properties": {
        "allocation_hostname": {
          "type": "string"
        },
        "allocation_image_id": {
          "type": "string"
        },
        "allocation_name": {
          "type": "string"
        },
        "allocation_project": {
          "type": "string"
        },
        "allocation_role": {
          "type": "string"
        },
        "allocation_succeeded": {
          "type": "boolean"
        },
        "disk_names": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "disk_sizes": {
          "items": {
            "format": "int64",
            "type": "integer"
          },
          "type": "array"
        },
        "fru_board_mfg": {
          "type": "string"
        },
        "fru_board_mfg_serial": {
          "type": "string"
        },
        "fru_board_part_number": {
          "type": "string"
        },
        "fru_chassis_part_number": {
          "type": "string"
        },
        "fru_chassis_part_serial": {
          "type": "string"
        },
        "fru_product_manufacturer": {
          "type": "string"
        },
        "fru_product_part_number": {
          "type": "string"
        },
        "fru_product_serial": {
          "type": "string"
        },
        "hardware_memory": {
          "format": "int64",
          "type": "integer"
        },
        "id": {
          "type": "string"
        },
        "ipmi_address": {
          "type": "string"
        },
        "ipmi_interface": {
          "type": "string"
        },
        "ipmi_mac_address": {
          "type": "string"
        },
        "ipmi_user": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "network_asns": {
          "items": {
            "format": "int64",
            "type": "integer"
          },
          "type": "array"
        },
        "network_destination_prefixes": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "network_ids": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "network_ips": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "network_prefixes": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "network_vrfs": {
          "items": {
            "format": "int64",
            "type": "integer"
          },
          "type": "array"
        },
        "nics_mac_addresses": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_names": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_neighbor_mac_addresses": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_neighbor_names": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_neighbor_vrfs": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_vrfs": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "partition_id": {
          "type": "string"
        },
        "rackid": {
          "type": "string"
        },
        "sizeid": {
          "type": "string"
        },
        "state_value": {
          "enum": [
            "",
            "LOCKED",
            "RESERVED"
          ],
          "type": "string"
        },
        "tags": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      }
    },
    "v1.FirewallIngressRule": {
      "properties": {
        "comment": {
          "description": "an optional comment describing what this rule is used for",
          "type": "string"
        },
        "from": {
          "description": "the cidrs affected by this rule",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "ports": {
          "description": "the ports affected by this rule",
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": "array"
        },
        "protocol": {
          "description": "the protocol for the rule, defaults to tcp",
          "enum": [
            "tcp",
            "udp"
          ],
          "type": "string"
        },
        "to": {
          "description": "the cidrs affected by this rule",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "from",
        "ports"
      ]
    },
    "v1.FirewallResponse": {
      "properties": {
        "allocation": {
          "$ref": "#/definitions/v1.MachineAllocation",
          "description": "the allocation data of an allocated machine"
        },
        "bios": {
          "$ref": "#/definitions/v1.MachineBIOS",
          "description": "bios information of this machine"
        },
        "changed": {
          "description": "the last changed timestamp of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "created": {
          "description": "the creation time of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "events": {
          "$ref": "#/definitions/v1.MachineRecentProvisioningEvents",
          "description": "recent events of this machine during provisioning"
        },
        "hardware": {
          "$ref": "#/definitions/v1.MachineHardware",
          "description": "the hardware of this machine"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "ledstate": {
          "$ref": "#/definitions/v1.ChassisIdentifyLEDState",
          "description": "the state of this chassis identify LED"
        },
        "liveliness": {
          "description": "the liveliness of this machine",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "partition": {
          "$ref": "#/definitions/v1.PartitionResponse",
          "description": "the partition assigned to this machine",
          "readOnly": true
        },
        "rackid": {
          "description": "the rack assigned to this machine",
          "readOnly": true,
          "type": "string"
        },
        "size": {
          "$ref": "#/definitions/v1.SizeResponse",
          "description": "the size of this machine",
          "readOnly": true
        },
        "state": {
          "$ref": "#/definitions/v1.MachineState",
          "description": "the state of this machine"
        },
        "tags": {
          "description": "tags for this machine",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "bios",
        "events",
        "hardware",
        "id",
        "ledstate",
        "liveliness",
        "state",
        "tags"
      ]
    },
    "v1.FirewallRules": {
      "properties": {
        "egress": {
          "description": "list of egress rules to be deployed during firewall allocation",
          "items": {
            "$ref": "#/definitions/v1.FirewallEgressRule"
          },
          "type": "array"
        },
        "ingress": {
          "description": "list of ingress rules to be deployed during firewall allocation",
          "items": {
            "$ref": "#/definitions/v1.FirewallIngressRule"
          },
          "type": "array"
        }
      }
    },
    "v1.FirmwaresResponse": {
      "properties": {
        "revisions": {
          "additionalProperties": {
            "$ref": "#/definitions/v1.VendorRevisions"
          },
          "description": "list of firmwares per board per vendor per kind",
          "type": "object"
        }
      },
      "required": [
        "revisions"
      ]
    },
    "v1.IAMConfig": {
      "properties": {
        "idm_config": {
          "$ref": "#/definitions/v1.IDMConfig"
        },
        "issuer_config": {
          "$ref": "#/definitions/v1.IssuerConfig"
        }
      }
    },
    "v1.IDMConfig": {
      "properties": {
        "idm_type": {
          "type": "string"
        }
      }
    },
    "v1.IPAllocateRequest": {
      "properties": {
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "machineid": {
          "description": "the machine id this ip should be associated with",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "networkid": {
          "description": "the network this ip allocate request address belongs to",
          "type": "string"
        },
        "projectid": {
          "description": "the project this ip address belongs to",
          "type": "string"
        },
        "tags": {
          "description": "free tags that you associate with this ip.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "type": {
          "description": "the ip type, ephemeral leads to automatic cleanup of the ip address, static will enable re-use of the ip at a later point in time",
          "enum": [
            "ephemeral",
            "static"
          ],
          "type": "string"
        }
      },
      "required": [
        "networkid",
        "projectid",
        "type"
      ]
    },
    "v1.IPBase": {
      "properties": {
        "networkid": {
          "description": "the network this ip allocate request address belongs to",
          "type": "string"
        },
        "projectid": {
          "description": "the project this ip address belongs to",
          "type": "string"
        },
        "tags": {
          "description": "free tags that you associate with this ip.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "type": {
          "description": "the ip type, ephemeral leads to automatic cleanup of the ip address, static will enable re-use of the ip at a later point in time",
          "enum": [
            "ephemeral",
            "static"
          ],
          "type": "string"
        }
      },
      "required": [
        "networkid",
        "projectid",
        "type"
      ]
    },
    "v1.IPFindRequest": {
      "properties": {
        "allocationuuid": {
          "description": "a unique identifier for this ip address allocation, can be used to distinguish between ip address allocation over time.",
          "type": "string"
        },
        "ipaddress": {
          "description": "the address (ipv4 or ipv6) of this ip",
          "type": "string"
        },
        "machineid": {
          "description": "the machine an ip address is associated to",
          "type": "string"
        },
        "name": {
          "description": "the name of the ip address",
          "type": "string"
        },
        "networkid": {
          "description": "the network this ip allocate request address belongs to",
          "type": "string"
        },
        "networkprefix": {
          "description": "the prefix of the network this ip address belongs to",
          "type": "string"
        },
        "projectid": {
          "description": "the project this ip address belongs to, empty if not strong coupled",
          "type": "string"
        },
        "tags": {
          "description": "the tags that are assigned to this ip address",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "type": {
          "description": "the type of the ip address, ephemeral or static",
          "type": "string"
        }
      }
    },
    "v1.IPIdentifiable": {
      "description": "an ip address that can be attached to a machine",
      "properties": {
        "allocationuuid": {
          "description": "a unique identifier for this ip address allocation, can be used to distinguish between ip address allocation over time.",
          "type": "string"
        },
        "ipaddress": {
          "description": "the address (ipv4 or ipv6) of this ip",
          "type": "string"
        }
      },
      "required": [
        "allocationuuid",
        "ipaddress"
      ]
    },
    "v1.IPResponse": {
      "properties": {
        "allocationuuid": {
          "description": "a unique identifier for this ip address allocation, can be used to distinguish between ip address allocation over time.",
          "type": "string"
        },
        "changed": {
          "description": "the last changed timestamp of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "created": {
          "description": "the creation time of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "ipaddress": {
          "description": "the address (ipv4 or ipv6) of this ip",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "networkid": {
          "description": "the network this ip allocate request address belongs to",
          "type": "string"
        },
        "projectid": {
          "description": "the project this ip address belongs to",
          "type": "string"
        },
        "tags": {
          "description": "free tags that you associate with this ip.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "type": {
          "description": "the ip type, ephemeral leads to automatic cleanup of the ip address, static will enable re-use of the ip at a later point in time",
          "enum": [
            "ephemeral",
            "static"
          ],
          "type": "string"
        }
      },
      "required": [
        "allocationuuid",
        "ipaddress",
        "networkid",
        "projectid",
        "type"
      ]
    },
    "v1.IPUpdateRequest": {
      "description": "an ip address that can be attached to a machine",
      "properties": {
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "ipaddress": {
          "description": "the address (ipv4 or ipv6) of this ip",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "tags": {
          "description": "free tags that you associate with this ip.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "type": {
          "description": "the ip type, ephemeral leads to automatic cleanup of the ip address, static will enable re-use of the ip at a later point in time",
          "enum": [
            "ephemeral",
            "static"
          ],
          "type": "string"
        }
      },
      "required": [
        "ipaddress",
        "type"
      ]
    },
    "v1.Identifiable": {
      "properties": {
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        }
      },
      "required": [
        "id"
      ]
    },
    "v1.ImageBase": {
      "description": "an image that can be attached to a machine",
      "properties": {
        "classification": {
          "description": "classification of this image",
          "type": "string"
        },
        "expirationDate": {
          "description": "expirationDate of this image",
          "format": "date-time",
          "type": "string"
        },
        "features": {
          "description": "features of this image",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "url": {
          "description": "the url of this image",
          "type": "string"
        },
        "usedby": {
          "description": "machines where this image is in use",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "expirationDate"
      ]
    },
    "v1.ImageCreateRequest": {
      "properties": {
        "classification": {
          "description": "classification of this image",
          "type": "string"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "expirationDate": {
          "description": "expirationDate of this image",
          "format": "date-time",
          "type": "string"
        },
        "features": {
          "description": "features of this image",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "url": {
          "description": "the url of this image",
          "type": "string"
        }
      },
      "required": [
        "id",
        "url"
      ]
    },
    "v1.ImageFindRequest": {
      "properties": {
        "classification": {
          "enum": [
            "deprecated",
            "preview",
            "supported"
          ],
          "type": "string"
        },
        "features": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "os": {
          "type": "string"
        },
        "version": {
          "type": "string"
        }
      }
    },
    "v1.ImageResponse": {
      "properties": {
        "changed": {
          "description": "the last changed timestamp of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "classification": {
          "description": "classification of this image",
          "type": "string"
        },
        "created": {
          "description": "the creation time of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "expirationDate": {
          "description": "expirationDate of this image",
          "format": "date-time",
          "type": "string"
        },
        "features": {
          "description": "features of this image",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "url": {
          "description": "the url of this image",
          "type": "string"
        },
        "usedby": {
          "description": "machines where this image is in use",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "expirationDate",
        "id"
      ]
    },
    "v1.ImageUpdateRequest": {
      "properties": {
        "classification": {
          "description": "classification of this image",
          "type": "string"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "expirationDate": {
          "description": "expirationDate of this image",
          "format": "date-time",
          "type": "string"
        },
        "features": {
          "description": "features of this image",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "url": {
          "description": "the url of this image",
          "type": "string"
        },
        "usedby": {
          "description": "machines where this image is in use",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "expirationDate",
        "id"
      ]
    },
    "v1.IssuerConfig": {
      "properties": {
        "client_id": {
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      }
    },
    "v1.LogicalVolume": {
      "properties": {
        "lvmtype": {
          "description": "the type of this logical volume can be either linear|striped|raid1",
          "type": "string"
        },
        "name": {
          "description": "the name of the logical volume",
          "type": "string"
        },
        "size": {
          "description": "size in mebibytes (MiB) of this volume",
          "format": "integer",
          "type": "integer"
        },
        "volumegroup": {
          "description": "the name of the volume group where to create the logical volume onto",
          "type": "string"
        }
      },
      "required": [
        "lvmtype",
        "name",
        "size",
        "volumegroup"
      ]
    },
    "v1.MachineAllocateRequest": {
      "properties": {
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "filesystemlayoutid": {
          "description": "the filesystemlayout id to assign to this machine",
          "type": "string"
        },
        "hostname": {
          "description": "the hostname for the allocated machine (defaults to metal)",
          "type": "string"
        },
        "imageid": {
          "description": "the image id to assign this machine to",
          "type": "string"
        },
        "ips": {
          "description": "the ips to attach to this machine additionally",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "networks": {
          "description": "the networks that this machine will be placed in.",
          "items": {
            "$ref": "#/definitions/v1.MachineAllocationNetwork"
          },
          "type": "array"
        },
        "partitionid": {
          "description": "the partition id to assign this machine to",
          "type": "string"
        },
        "placement_tags": {
          "description": "by default machines are spread across the racks inside a partition for every project. if placement tags are provided, the machine candidate has an additional anti-affinity to other machines having the same tags",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "projectid": {
          "description": "the project id to assign this machine to",
          "type": "string"
        },
        "sizeid": {
          "description": "the size id to assign this machine to",
          "type": "string"
        },
        "ssh_pub_keys": {
          "description": "the public ssh keys to access the machine with",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "tags": {
          "description": "tags for this machine",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "user_data": {
          "description": "cloud-init.io compatible userdata must be base64 encoded",
          "type": "string"
        },
        "uuid": {
          "description": "if this field is set, this specific machine will be allocated if it is not in available state and not currently allocated. this field overrules size and partition",
          "type": "string"
        }
      },
      "required": [
        "imageid",
        "partitionid",
        "projectid",
        "sizeid",
        "ssh_pub_keys"
      ]
    },
    "v1.MachineAllocation": {
      "properties": {
        "allocationuuid": {
          "description": "a unique identifier for this machine allocation, can be used to distinguish between machine allocations over time.",
          "type": "string"
        },
        "boot_info": {
          "$ref": "#/definitions/v1.BootInfo",
          "description": "information required for booting the machine from HD"
        },
        "created": {
          "description": "the time when the machine was created",
          "format": "date-time",
          "type": "string"
        },
        "creator": {
          "description": "email of machine creator",
          "type": "string"
        },
        "description": {
          "description": "a description for this machine",
          "type": "string"
        },
        "filesystemlayout": {
          "$ref": "#/definitions/v1.FilesystemLayoutResponse",
          "description": "filesystemlayout to create on this machine"
        },
        "firewall_rules": {
          "$ref": "#/definitions/v1.FirewallRules",
          "description": "a set of firewall rules to apply"
        },
        "hostname": {
          "description": "the hostname which will be used when creating the machine",
          "type": "string"
        },
        "image": {
          "$ref": "#/definitions/v1.ImageResponse",
          "description": "the image assigned to this machine",
          "readOnly": true
        },
        "name": {
          "description": "the name of the machine",
          "type": "string"
        },
        "networks": {
          "description": "the networks of this machine",
          "items": {
            "$ref": "#/definitions/v1.MachineNetwork"
          },
          "type": "array"
        },
        "project": {
          "description": "the project id that this machine is assigned to",
          "type": "string"
        },
        "reinstall": {
          "description": "indicates whether to reinstall the machine",
          "type": "boolean"
        },
        "role": {
          "description": "the role of the machine",
          "enum": [
            "firewall",
            "machine"
          ],
          "type": "string"
        },
        "ssh_pub_keys": {
          "description": "the public ssh keys to access the machine with",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "succeeded": {
          "description": "if the allocation of the machine was successful, this is set to true",
          "type": "boolean"
        },
        "user_data": {
          "description": "userdata to execute post installation tasks",
          "type": "string"
        },
        "vpn": {
          "$ref": "#/definitions/v1.MachineVPN",
          "description": "vpn connection info for machine"
        }
      },
      "required": [
        "allocationuuid",
        "created",
        "creator",
        "hostname",
        "name",
        "networks",
        "project",
        "reinstall",
        "role",
        "ssh_pub_keys",
        "succeeded"
      ]
    },
    "v1.MachineAllocationNetwork": {
      "properties": {
        "autoacquire": {
          "description": "will automatically acquire an ip in this network if set to true, default is true",
          "type": "boolean"
        },
        "networkid": {
          "description": "the id of the network that this machine will be placed in",
          "type": "string"
        }
      },
      "required": [
        "autoacquire",
        "networkid"
      ]
    },
    "v1.MachineBIOS": {
      "description": "The bios version",
      "properties": {
        "date": {
          "description": "the bios date",
          "type": "string"
        },
        "vendor": {
          "description": "the bios vendor",
          "type": "string"
        },
        "version": {
          "description": "the bios version",
          "type": "string"
        }
      },
      "required": [
        "date",
        "vendor",
        "version"
      ]
    },
    "v1.MachineBase": {
      "description": "A machine representing a bare metal machine.",
      "properties": {
        "allocation": {
          "$ref": "#/definitions/v1.MachineAllocation",
          "description": "the allocation data of an allocated machine"
        },
        "bios": {
          "$ref": "#/definitions/v1.MachineBIOS",
          "description": "bios information of this machine"
        },
        "events": {
          "$ref": "#/definitions/v1.MachineRecentProvisioningEvents",
          "description": "recent events of this machine during provisioning"
        },
        "hardware": {
          "$ref": "#/definitions/v1.MachineHardware",
          "description": "the hardware of this machine"
        },
        "ledstate": {
          "$ref": "#/definitions/v1.ChassisIdentifyLEDState",
          "description": "the state of this chassis identify LED"
        },
        "liveliness": {
          "description": "the liveliness of this machine",
          "type": "string"
        },
        "partition": {
          "$ref": "#/definitions/v1.PartitionResponse",
          "description": "the partition assigned to this machine",
          "readOnly": true
        },
        "rackid": {
          "description": "the rack assigned to this machine",
          "readOnly": true,
          "type": "string"
        },
        "size": {
          "$ref": "#/definitions/v1.SizeResponse",
          "description": "the size of this machine",
          "readOnly": true
        },
        "state": {
          "$ref": "#/definitions/v1.MachineState",
          "description": "the state of this machine"
        },
        "tags": {
          "description": "tags for this machine",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "bios",
        "events",
        "hardware",
        "ledstate",
        "liveliness",
        "state",
        "tags"
      ]
    },
    "v1.MachineBlockDevice": {
      "properties": {
        "name": {
          "description": "the name of this block device",
          "type": "string"
        },
        "size": {
          "description": "the size of this block device",
          "format": "integer",
          "type": "integer"
        }
      },
      "required": [
        "name",
        "size"
      ]
    },
    "v1.MachineConsolePasswordRequest": {
      "properties": {
        "id": {
          "description": "id of the machine to get the consolepassword for",
          "type": "string"
        },
        "reason": {
          "description": "reason why the consolepassword is requested, typically a incident number with short description",
          "type": "string"
        }
      },
      "required": [
        "id",
        "reason"
      ]
    },
    "v1.MachineConsolePasswordResponse": {
      "properties": {
        "console_password": {
          "description": "the console password which was generated while provisioning",
          "type": "string"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        }
      },
      "required": [
        "console_password",
        "id"
      ]
    },
    "v1.MachineFindRequest": {
      "properties": {
        "allocation_hostname": {
          "type": "string"
        },
        "allocation_image_id": {
          "type": "string"
        },
        "allocation_name": {
          "type": "string"
        },
        "allocation_project": {
          "type": "string"
        },
        "allocation_role": {
          "type": "string"
        },
        "allocation_succeeded": {
          "type": "boolean"
        },
        "disk_names": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "disk_sizes": {
          "items": {
            "format": "int64",
            "type": "integer"
          },
          "type": "array"
        },
        "fru_board_mfg": {
          "type": "string"
        },
        "fru_board_mfg_serial": {
          "type": "string"
        },
        "fru_board_part_number": {
          "type": "string"
        },
        "fru_chassis_part_number": {
          "type": "string"
        },
        "fru_chassis_part_serial": {
          "type": "string"
        },
        "fru_product_manufacturer": {
          "type": "string"
        },
        "fru_product_part_number": {
          "type": "string"
        },
        "fru_product_serial": {
          "type": "string"
        },
        "hardware_memory": {
          "format": "int64",
          "type": "integer"
        },
        "id": {
          "type": "string"
        },
        "ipmi_address": {
          "type": "string"
        },
        "ipmi_interface": {
          "type": "string"
        },
        "ipmi_mac_address": {
          "type": "string"
        },
        "ipmi_user": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "network_asns": {
          "items": {
            "format": "int64",
            "type": "integer"
          },
          "type": "array"
        },
        "network_destination_prefixes": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "network_ids": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "network_ips": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "network_prefixes": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "network_vrfs": {
          "items": {
            "format": "int64",
            "type": "integer"
          },
          "type": "array"
        },
        "nics_mac_addresses": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_names": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_neighbor_mac_addresses": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_neighbor_names": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_neighbor_vrfs": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_vrfs": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "partition_id": {
          "type": "string"
        },
        "rackid": {
          "type": "string"
        },
        "sizeid": {
          "type": "string"
        },
        "state_value": {
          "enum": [
            "",
            "LOCKED",
            "RESERVED"
          ],
          "type": "string"
        },
        "tags": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      }
    },
    "v1.MachineFru": {
      "description": "The Field Replaceable Unit data",
      "properties": {
        "board_mfg": {
          "description": "the board mfg",
          "type": "string"
        },
        "board_mfg_serial": {
          "description": "the board mfg serial",
          "type": "string"
        },
        "board_part_number": {
          "description": "the board part number",
          "type": "string"
        },
        "chassis_part_number": {
          "description": "the chassis part number",
          "type": "string"
        },
        "chassis_part_serial": {
          "description": "the chassis part serial",
          "type": "string"
        },
        "product_manufacturer": {
          "description": "the product manufacturer",
          "type": "string"
        },
        "product_part_number": {
          "description": "the product part number",
          "type": "string"
        },
        "product_serial": {
          "description": "the product serial",
          "type": "string"
        }
      }
    },
    "v1.MachineHardware": {
      "properties": {
        "cpu_cores": {
          "description": "the number of cpu cores",
          "format": "int32",
          "type": "integer"
        },
        "cpus": {
          "description": "the cpu details",
          "items": {
            "$ref": "#/definitions/v1.MetalCPU"
          },
          "type": "array"
        },
        "disks": {
          "description": "the list of block devices of this machine",
          "items": {
            "$ref": "#/definitions/v1.MachineBlockDevice"
          },
          "type": "array"
        },
        "gpus": {
          "description": "the gpu details",
          "items": {
            "$ref": "#/definitions/v1.MetalGPU"
          },
          "type": "array"
        },
        "memory": {
          "description": "the total memory of the machine",
          "format": "integer",
          "type": "integer"
        },
        "nics": {
          "description": "the list of network interfaces of this machine",
          "items": {
            "$ref": "#/definitions/v1.MachineNic"
          },
          "type": "array"
        }
      },
      "required": [
        "cpu_cores",
        "disks",
        "memory",
        "nics"
      ]
    },
    "v1.MachineHardwareBase": {
      "properties": {
        "cpu_cores": {
          "description": "the number of cpu cores",
          "format": "int32",
          "type": "integer"
        },
        "cpus": {
          "description": "the cpu details",
          "items": {
            "$ref": "#/definitions/v1.MetalCPU"
          },
          "type": "array"
        },
        "disks": {
          "description": "the list of block devices of this machine",
          "items": {
            "$ref": "#/definitions/v1.MachineBlockDevice"
          },
          "type": "array"
        },
        "gpus": {
          "description": "the gpu details",
          "items": {
            "$ref": "#/definitions/v1.MetalGPU"
          },
          "type": "array"
        },
        "memory": {
          "description": "the total memory of the machine",
          "format": "integer",
          "type": "integer"
        }
      },
      "required": [
        "cpu_cores",
        "disks",
        "memory"
      ]
    },
    "v1.MachineIPMI": {
      "description": "The IPMI connection data",
      "properties": {
        "address": {
          "type": "string"
        },
        "bmcversion": {
          "type": "string"
        },
        "fru": {
          "$ref": "#/definitions/v1.MachineFru"
        },
        "interface": {
          "type": "string"
        },
        "last_updated": {
          "format": "date-time",
          "type": "string"
        },
        "mac": {
          "type": "string"
        },
        "password": {
          "type": "string"
        },
        "powermetric": {
          "$ref": "#/definitions/v1.PowerMetric"
        },
        "powerstate": {
          "type": "string"
        },
        "powersupplies": {
          "items": {
            "$ref": "#/definitions/v1.PowerSupply"
          },
          "type": "array"
        },
        "user": {
          "type": "string"
        }
      },
      "required": [
        "address",
        "bmcversion",
        "fru",
        "interface",
        "last_updated",
        "mac",
        "password",
        "powermetric",
        "powerstate",
        "powersupplies",
        "user"
      ]
    },
    "v1.MachineIPMIResponse": {
      "properties": {
        "allocation": {
          "$ref": "#/definitions/v1.MachineAllocation",
          "description": "the allocation data of an allocated machine"
        },
        "bios": {
          "$ref": "#/definitions/v1.MachineBIOS",
          "description": "bios information of this machine"
        },
        "changed": {
          "description": "the last changed timestamp of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "created": {
          "description": "the creation time of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "events": {
          "$ref": "#/definitions/v1.MachineRecentProvisioningEvents",
          "description": "recent events of this machine during provisioning"
        },
        "hardware": {
          "$ref": "#/definitions/v1.MachineHardware",
          "description": "the hardware of this machine"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "ipmi": {
          "$ref": "#/definitions/v1.MachineIPMI",
          "description": "ipmi information of this machine"
        },
        "ledstate": {
          "$ref": "#/definitions/v1.ChassisIdentifyLEDState",
          "description": "the state of this chassis identify LED"
        },
        "liveliness": {
          "description": "the liveliness of this machine",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "partition": {
          "$ref": "#/definitions/v1.PartitionResponse",
          "description": "the partition assigned to this machine",
          "readOnly": true
        },
        "rackid": {
          "description": "the rack assigned to this machine",
          "readOnly": true,
          "type": "string"
        },
        "size": {
          "$ref": "#/definitions/v1.SizeResponse",
          "description": "the size of this machine",
          "readOnly": true
        },
        "state": {
          "$ref": "#/definitions/v1.MachineState",
          "description": "the state of this machine"
        },
        "tags": {
          "description": "tags for this machine",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "bios",
        "events",
        "hardware",
        "id",
        "ipmi",
        "ledstate",
        "liveliness",
        "state",
        "tags"
      ]
    },
    "v1.MachineIpmiReport": {
      "properties": {
        "BIOSVersion": {
          "type": "string"
        },
        "BMCIp": {
          "type": "string"
        },
        "BMCVersion": {
          "type": "string"
        },
        "FRU": {
          "$ref": "#/definitions/v1.MachineFru"
        },
        "IndicatorLEDState": {
          "type": "string"
        },
        "PowerMetric": {
          "$ref": "#/definitions/v1.PowerMetric"
        },
        "PowerState": {
          "type": "string"
        },
        "PowerSupplies": {
          "items": {
            "$ref": "#/definitions/v1.PowerSupply"
          },
          "type": "array"
        }
      },
      "required": [
        "BIOSVersion",
        "BMCIp",
        "BMCVersion",
        "FRU",
        "IndicatorLEDState",
        "PowerMetric",
        "PowerState",
        "PowerSupplies"
      ]
    },
    "v1.MachineIpmiReportResponse": {
      "properties": {
        "created": {
          "description": "the machine uuids that triggered a creation of a machine entity",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "updated": {
          "description": "the machine uuids that triggered an update of ipmi data",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "created",
        "updated"
      ]
    },
    "v1.MachineIpmiReports": {
      "properties": {
        "partitionid": {
          "description": "the partition id for the ipmi report",
          "type": "string"
        },
        "reports": {
          "additionalProperties": {
            "$ref": "#/definitions/v1.MachineIpmiReport"
          },
          "description": "uuid to machinereport",
          "type": "object"
        }
      }
    },
    "v1.MachineIssue": {
      "properties": {
        "description": {
          "description": "a description of the issue",
          "type": "string"
        },
        "details": {
          "description": "details of the issue",
          "type": "string"
        },
        "id": {
          "description": "the id of the issue",
          "type": "string"
        },
        "ref_url": {
          "description": "an issue reference to the issue in metal-stack docs",
          "type": "string"
        },
        "severity": {
          "description": "the severity of the issue",
          "type": "string"
        }
      },
      "required": [
        "description",
        "details",
        "id",
        "ref_url",
        "severity"
      ]
    },
    "v1.MachineIssueResponse": {
      "properties": {
        "issues": {
          "description": "the list of issues (only issue ids) of this machine",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "machineid": {
          "description": "the machine id that has the given issues",
          "type": "string"
        }
      },
      "required": [
        "issues",
        "machineid"
      ]
    },
    "v1.MachineIssuesRequest": {
      "properties": {
        "allocation_hostname": {
          "type": "string"
        },
        "allocation_image_id": {
          "type": "string"
        },
        "allocation_name": {
          "type": "string"
        },
        "allocation_project": {
          "type": "string"
        },
        "allocation_role": {
          "type": "string"
        },
        "allocation_succeeded": {
          "type": "boolean"
        },
        "disk_names": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "disk_sizes": {
          "items": {
            "format": "int64",
            "type": "integer"
          },
          "type": "array"
        },
        "fru_board_mfg": {
          "type": "string"
        },
        "fru_board_mfg_serial": {
          "type": "string"
        },
        "fru_board_part_number": {
          "type": "string"
        },
        "fru_chassis_part_number": {
          "type": "string"
        },
        "fru_chassis_part_serial": {
          "type": "string"
        },
        "fru_product_manufacturer": {
          "type": "string"
        },
        "fru_product_part_number": {
          "type": "string"
        },
        "fru_product_serial": {
          "type": "string"
        },
        "hardware_memory": {
          "format": "int64",
          "type": "integer"
        },
        "id": {
          "type": "string"
        },
        "ipmi_address": {
          "type": "string"
        },
        "ipmi_interface": {
          "type": "string"
        },
        "ipmi_mac_address": {
          "type": "string"
        },
        "ipmi_user": {
          "type": "string"
        },
        "last_error_threshold": {
          "description": "defines the last error threshold",
          "format": "int64",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "network_asns": {
          "items": {
            "format": "int64",
            "type": "integer"
          },
          "type": "array"
        },
        "network_destination_prefixes": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "network_ids": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "network_ips": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "network_prefixes": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "network_vrfs": {
          "items": {
            "format": "int64",
            "type": "integer"
          },
          "type": "array"
        },
        "nics_mac_addresses": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_names": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_neighbor_mac_addresses": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_neighbor_names": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_neighbor_vrfs": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nics_vrfs": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "omit": {
          "description": "a list of machine issues to omit",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "only": {
          "description": "a list of machine issues to include",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "partition_id": {
          "type": "string"
        },
        "rackid": {
          "type": "string"
        },
        "severity": {
          "description": "filters issue for given severity",
          "type": "string"
        },
        "sizeid": {
          "type": "string"
        },
        "state_value": {
          "enum": [
            "",
            "LOCKED",
            "RESERVED"
          ],
          "type": "string"
        },
        "tags": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "last_error_threshold",
        "omit",
        "only",
        "severity"
      ]
    },
    "v1.MachineNetwork": {
      "description": "prefixes that are reachable within this network",
      "properties": {
        "asn": {
          "description": "ASN number for this network in the bgp configuration",
          "format": "int64",
          "type": "integer"
        },
        "destinationprefixes": {
          "description": "the destination prefixes of this network",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "ips": {
          "description": "the ip addresses of the allocated machine in this vrf",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nat": {
          "description": "if set to true, packets leaving this network get masqueraded behind interface ip",
          "type": "boolean"
        },
        "networkid": {
          "description": "the networkID of the allocated machine in this vrf",
          "type": "string"
        },
        "networktype": {
          "description": "the network type, types can be looked up in the network package of metal-lib",
          "type": "string"
        },
        "prefixes": {
          "description": "the prefixes of this network",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "private": {
          "description": "indicates whether this network is the private network of this machine",
          "type": "boolean"
        },
        "underlay": {
          "description": "if set to true, this network can be used for underlay communication",
          "type": "boolean"
        },
        "vrf": {
          "description": "the vrf of the allocated machine",
          "format": "integer",
          "type": "integer"
        }
      },
      "required": [
        "asn",
        "destinationprefixes",
        "ips",
        "nat",
        "networkid",
        "networktype",
        "prefixes",
        "private",
        "underlay",
        "vrf"
      ]
    },
    "v1.MachineNic": {
      "properties": {
        "identifier": {
          "description": "the unique identifier of this network interface",
          "type": "string"
        },
        "mac": {
          "description": "the mac address of this network interface",
          "type": "string"
        },
        "name": {
          "description": "the name of this network interface",
          "type": "string"
        },
        "neighbors": {
          "description": "the neighbors visible to this network interface",
          "items": {
            "$ref": "#/definitions/v1.MachineNic"
          },
          "type": "array"
        }
      },
      "required": [
        "identifier",
        "mac",
        "name",
        "neighbors"
      ]
    },
    "v1.MachineProvisioningEvent": {
      "properties": {
        "event": {
          "description": "the event emitted by the machine",
          "type": "string"
        },
        "message": {
          "description": "an additional message to add to the event",
          "type": "string"
        },
        "time": {
          "description": "the time that this event was received",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        }
      },
      "required": [
        "event"
      ]
    },
    "v1.MachineRecentProvisioningEvents": {
      "properties": {
        "crash_loop": {
          "description": "indicates that machine is provisioning crash loop",
          "type": "boolean"
        },
        "failed_machine_reclaim": {
          "description": "indicates that machine reclaim has failed",
          "type": "boolean"
        },
        "last_error_event": {
          "$ref": "#/definitions/v1.MachineProvisioningEvent",
          "description": "the last erroneous event received"
        },
        "last_event_time": {
          "description": "the time where the last event was received",
          "format": "date-time",
          "type": "string"
        },
        "log": {
          "description": "the log of recent machine provisioning events",
          "items": {
            "$ref": "#/definitions/v1.MachineProvisioningEvent"
          },
          "type": "array"
        }
      },
      "required": [
        "crash_loop",
        "failed_machine_reclaim",
        "log"
      ]
    },
    "v1.MachineReinstallRequest": {
      "properties": {
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "imageid": {
          "description": "the image id to be installed",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        }
      },
      "required": [
        "id",
        "imageid"
      ]
    },
    "v1.MachineResponse": {
      "properties": {
        "allocation": {
          "$ref": "#/definitions/v1.MachineAllocation",
          "description": "the allocation data of an allocated machine"
        },
        "bios": {
          "$ref": "#/definitions/v1.MachineBIOS",
          "description": "bios information of this machine"
        },
        "changed": {
          "description": "the last changed timestamp of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "created": {
          "description": "the creation time of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "events": {
          "$ref": "#/definitions/v1.MachineRecentProvisioningEvents",
          "description": "recent events of this machine during provisioning"
        },
        "hardware": {
          "$ref": "#/definitions/v1.MachineHardware",
          "description": "the hardware of this machine"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "ledstate": {
          "$ref": "#/definitions/v1.ChassisIdentifyLEDState",
          "description": "the state of this chassis identify LED"
        },
        "liveliness": {
          "description": "the liveliness of this machine",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "partition": {
          "$ref": "#/definitions/v1.PartitionResponse",
          "description": "the partition assigned to this machine",
          "readOnly": true
        },
        "rackid": {
          "description": "the rack assigned to this machine",
          "readOnly": true,
          "type": "string"
        },
        "size": {
          "$ref": "#/definitions/v1.SizeResponse",
          "description": "the size of this machine",
          "readOnly": true
        },
        "state": {
          "$ref": "#/definitions/v1.MachineState",
          "description": "the state of this machine"
        },
        "tags": {
          "description": "tags for this machine",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "bios",
        "events",
        "hardware",
        "id",
        "ledstate",
        "liveliness",
        "state",
        "tags"
      ]
    },
    "v1.MachineState": {
      "properties": {
        "description": {
          "description": "a description why this machine is in the given state",
          "type": "string"
        },
        "issuer": {
          "description": "the user that changed the state",
          "type": "string"
        },
        "metal_hammer_version": {
          "description": "the version of metal hammer which put the machine in waiting state",
          "type": "string"
        },
        "value": {
          "description": "the state of this machine. empty means available for all",
          "enum": [
            "",
            "LOCKED",
            "RESERVED"
          ],
          "type": "string"
        }
      },
      "required": [
        "description",
        "metal_hammer_version",
        "value"
      ]
    },
    "v1.MachineUpdateFirmwareRequest": {
      "properties": {
        "description": {
          "description": "a description why the machine has been updated",
          "type": "string"
        },
        "kind": {
          "description": "the firmware kind, i.e. [bios|bmc]",
          "enum": [
            "bios",
            "bmc"
          ],
          "type": "string"
        },
        "revision": {
          "description": "the update revision",
          "type": "string"
        }
      },
      "required": [
        "description",
        "kind",
        "revision"
      ]
    },
    "v1.MachineUpdateRequest": {
      "properties": {
        "description": {
          "description": "a description for this machine",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "ssh_pub_keys": {
          "description": "the public ssh keys to access the machine with",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "tags": {
          "description": "tags for this machine.",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "description",
        "id"
      ]
    },
    "v1.MachineVPN": {
      "properties": {
        "address": {
          "description": "address of VPN control plane",
          "type": "string"
        },
        "auth_key": {
          "description": "auth key used to connect to VPN",
          "type": "string"
        },
        "connected": {
          "description": "connected to the VPN",
          "type": "boolean"
        }
      },
      "required": [
        "address",
        "auth_key",
        "connected"
      ]
    },
    "v1.Meta": {
      "properties": {
        "annotations": {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        "apiversion": {
          "type": "string"
        },
        "created_time": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "kind": {
          "type": "string"
        },
        "labels": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "updated_time": {
          "format": "date-time",
          "type": "string"
        },
        "version": {
          "format": "int64",
          "type": "integer"
        }
      }
    },
    "v1.MetalCPU": {
      "properties": {
        "cores": {
          "description": "the cpu cores",
          "format": "integer",
          "type": "integer"
        },
        "model": {
          "description": "the cpu model",
          "type": "string"
        },
        "threads": {
          "description": "the cpu threads",
          "format": "integer",
          "type": "integer"
        },
        "vendor": {
          "description": "the cpu vendor",
          "type": "string"
        }
      },
      "required": [
        "cores",
        "model",
        "threads",
        "vendor"
      ]
    },
    "v1.MetalGPU": {
      "properties": {
        "model": {
          "description": "the gpu model",
          "type": "string"
        },
        "vendor": {
          "description": "the gpu vendor",
          "type": "string"
        }
      },
      "required": [
        "model",
        "vendor"
      ]
    },
    "v1.NetworkAllocateRequest": {
      "properties": {
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "destinationprefixes": {
          "description": "the destination prefixes of this network",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "free labels that you associate with this network.",
          "type": "object"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "nat": {
          "description": "if set to true, packets leaving this network get masqueraded behind interface ip",
          "type": "boolean"
        },
        "partitionid": {
          "description": "the partition this network belongs to",
          "type": "string"
        },
        "projectid": {
          "description": "the project id this network belongs to, can be empty if globally available",
          "type": "string"
        },
        "shared": {
          "description": "marks a network as shareable.",
          "type": "boolean"
        }
      }
    },
    "v1.NetworkBase": {
      "properties": {
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "free labels that you associate with this network.",
          "type": "object"
        },
        "partitionid": {
          "description": "the partition this network belongs to",
          "type": "string"
        },
        "projectid": {
          "description": "the project id this network belongs to, can be empty if globally available",
          "type": "string"
        },
        "shared": {
          "description": "marks a network as shareable.",
          "type": "boolean"
        }
      }
    },
    "v1.NetworkCreateRequest": {
      "properties": {
        "additionalAnnouncableCIDRs": {
          "description": "list of cidrs which are added to the route maps per tenant private network, these are typically pod- and service cidrs, can only be set for private super networks",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "destinationprefixes": {
          "description": "the destination prefixes of this network",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "id": {
          "description": "the unique ID of this entity, auto-generated if left empty",
          "type": "string"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "free labels that you associate with this network.",
          "type": "object"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "nat": {
          "description": "if set to true, packets leaving this network get masqueraded behind interface ip",
          "type": "boolean"
        },
        "parentnetworkid": {
          "description": "the id of the parent network",
          "type": "string"
        },
        "partitionid": {
          "description": "the partition this network belongs to",
          "type": "string"
        },
        "prefixes": {
          "description": "the prefixes of this network",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "privatesuper": {
          "description": "if set to true, this network will serve as a partition's super network for the internal machine networks,there can only be one privatesuper network per partition",
          "type": "boolean"
        },
        "projectid": {
          "description": "the project id this network belongs to, can be empty if globally available",
          "type": "string"
        },
        "shared": {
          "description": "marks a network as shareable.",
          "type": "boolean"
        },
        "underlay": {
          "description": "if set to true, this network can be used for underlay communication",
          "type": "boolean"
        },
        "vrf": {
          "description": "the vrf this network is associated with",
          "format": "integer",
          "type": "integer"
        },
        "vrfshared": {
          "description": "if set to true, given vrf can be used by multiple networks, which is sometimes useful for network partitioning (default: false)",
          "type": "boolean"
        }
      },
      "required": [
        "destinationprefixes",
        "id",
        "nat",
        "prefixes",
        "privatesuper",
        "underlay"
      ]
    },
    "v1.NetworkFindRequest": {
      "properties": {
        "destinationprefixes": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "id": {
          "type": "string"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        "name": {
          "type": "string"
        },
        "nat": {
          "type": "boolean"
        },
        "parentnetworkid": {
          "type": "string"
        },
        "partitionid": {
          "type": "string"
        },
        "prefixes": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "privatesuper": {
          "type": "boolean"
        },
        "projectid": {
          "type": "string"
        },
        "underlay": {
          "type": "boolean"
        },
        "vrf": {
          "format": "int64",
          "type": "integer"
        }
      }
    },
    "v1.NetworkImmutable": {
      "description": "a network which contains prefixes from which IP addresses can be allocated\nprefixes that are reachable within this network",
      "properties": {
        "additionalAnnouncableCIDRs": {
          "description": "list of cidrs which are added to the route maps per tenant private network, these are typically pod- and service cidrs, can only be set for private super networks",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "destinationprefixes": {
          "description": "the destination prefixes of this network",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "nat": {
          "description": "if set to true, packets leaving this network get masqueraded behind interface ip",
          "type": "boolean"
        },
        "parentnetworkid": {
          "description": "the id of the parent network",
          "type": "string"
        },
        "prefixes": {
          "description": "the prefixes of this network",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "privatesuper": {
          "description": "if set to true, this network will serve as a partition's super network for the internal machine networks,there can only be one privatesuper network per partition",
          "type": "boolean"
        },
        "underlay": {
          "description": "if set to true, this network can be used for underlay communication",
          "type": "boolean"
        },
        "vrf": {
          "description": "the vrf this network is associated with",
          "format": "integer",
          "type": "integer"
        },
        "vrfshared": {
          "description": "if set to true, given vrf can be used by multiple networks, which is sometimes useful for network partitioning (default: false)",
          "type": "boolean"
        }
      },
      "required": [
        "destinationprefixes",
        "nat",
        "prefixes",
        "privatesuper",
        "underlay"
      ]
    },
    "v1.NetworkResponse": {
      "properties": {
        "additionalAnnouncableCIDRs": {
          "description": "list of cidrs which are added to the route maps per tenant private network, these are typically pod- and service cidrs, can only be set for private super networks",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "changed": {
          "description": "the last changed timestamp of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "created": {
          "description": "the creation time of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "destinationprefixes": {
          "description": "the destination prefixes of this network",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "free labels that you associate with this network.",
          "type": "object"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "nat": {
          "description": "if set to true, packets leaving this network get masqueraded behind interface ip",
          "type": "boolean"
        },
        "parentnetworkid": {
          "description": "the id of the parent network",
          "type": "string"
        },
        "partitionid": {
          "description": "the partition this network belongs to",
          "type": "string"
        },
        "prefixes": {
          "description": "the prefixes of this network",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "privatesuper": {
          "description": "if set to true, this network will serve as a partition's super network for the internal machine networks,there can only be one privatesuper network per partition",
          "type": "boolean"
        },
        "projectid": {
          "description": "the project id this network belongs to, can be empty if globally available",
          "type": "string"
        },
        "shared": {
          "description": "marks a network as shareable.",
          "type": "boolean"
        },
        "underlay": {
          "description": "if set to true, this network can be used for underlay communication",
          "type": "boolean"
        },
        "usage": {
          "$ref": "#/definitions/v1.NetworkUsage",
          "description": "usage of ips and prefixes in this network"
        },
        "vrf": {
          "description": "the vrf this network is associated with",
          "format": "integer",
          "type": "integer"
        },
        "vrfshared": {
          "description": "if set to true, given vrf can be used by multiple networks, which is sometimes useful for network partitioning (default: false)",
          "type": "boolean"
        }
      },
      "required": [
        "destinationprefixes",
        "id",
        "nat",
        "prefixes",
        "privatesuper",
        "underlay",
        "usage"
      ]
    },
    "v1.NetworkUpdateRequest": {
      "properties": {
        "additionalAnnouncableCIDRs": {
          "description": "list of cidrs which are added to the route maps per tenant private network, these are typically pod- and service cidrs, can only be set for private super networks",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "destinationprefixes": {
          "description": "the destination prefixes of this network",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "free labels that you associate with this network.",
          "type": "object"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "prefixes": {
          "description": "the prefixes of this network",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "shared": {
          "description": "marks a network as shareable.",
          "type": "boolean"
        }
      },
      "required": [
        "id"
      ]
    },
    "v1.NetworkUsage": {
      "properties": {
        "available_ips": {
          "description": "the total available IPs",
          "format": "integer",
          "type": "integer"
        },
        "available_prefixes": {
          "description": "the total available 2 bit Prefixes",
          "format": "integer",
          "type": "integer"
        },
        "used_ips": {
          "description": "the total used IPs",
          "format": "integer",
          "type": "integer"
        },
        "used_prefixes": {
          "description": "the total used Prefixes",
          "format": "integer",
          "type": "integer"
        }
      },
      "required": [
        "available_ips",
        "available_prefixes",
        "used_ips",
        "used_prefixes"
      ]
    },
    "v1.Paging": {
      "properties": {
        "count": {
          "format": "integer",
          "type": "integer"
        },
        "page": {
          "format": "integer",
          "type": "integer"
        }
      }
    },
    "v1.PartitionBase": {
      "properties": {
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "free labels that you associate with this partition",
          "type": "object"
        },
        "mgmtserviceaddress": {
          "description": "the address to the management service of this partition",
          "type": "string"
        },
        "privatenetworkprefixlength": {
          "description": "the length of private networks for the machine's child networks in this partition, default 22",
          "format": "int32",
          "maximum": 30,
          "minimum": 16,
          "type": "integer"
        }
      }
    },
    "v1.PartitionBootConfiguration": {
      "description": "a partition has a distinct location in a data center, individual entities belong to a partition",
      "properties": {
        "commandline": {
          "description": "the cmdline to the kernel for the boot image",
          "type": "string"
        },
        "imageurl": {
          "description": "the url to download the initrd for the boot image",
          "type": "string"
        },
        "kernelurl": {
          "description": "the url to download the kernel for the boot image",
          "type": "string"
        }
      }
    },
    "v1.PartitionCapacity": {
      "properties": {
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "servers": {
          "description": "servers available in this partition",
          "items": {
            "$ref": "#/definitions/v1.ServerCapacity"
          },
          "type": "array"
        }
      },
      "required": [
        "id",
        "servers"
      ]
    },
    "v1.PartitionCapacityRequest": {
      "properties": {
        "id": {
          "description": "the id of the partition",
          "type": "string"
        },
        "sizeid": {
          "description": "the size to filter for",
          "type": "string"
        }
      }
    },
    "v1.PartitionCreateRequest": {
      "properties": {
        "bootconfig": {
          "$ref": "#/definitions/v1.PartitionBootConfiguration",
          "description": "the boot configuration of this partition"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "free labels that you associate with this partition",
          "type": "object"
        },
        "mgmtserviceaddress": {
          "description": "the address to the management service of this partition",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "privatenetworkprefixlength": {
          "description": "the length of private networks for the machine's child networks in this partition, default 22",
          "format": "int32",
          "maximum": 30,
          "minimum": 16,
          "type": "integer"
        }
      },
      "required": [
        "bootconfig",
        "id"
      ]
    },
    "v1.PartitionResponse": {
      "properties": {
        "bootconfig": {
          "$ref": "#/definitions/v1.PartitionBootConfiguration",
          "description": "the boot configuration of this partition"
        },
        "changed": {
          "description": "the last changed timestamp of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "created": {
          "description": "the creation time of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "free labels that you associate with this partition",
          "type": "object"
        },
        "mgmtserviceaddress": {
          "description": "the address to the management service of this partition",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "privatenetworkprefixlength": {
          "description": "the length of private networks for the machine's child networks in this partition, default 22",
          "format": "int32",
          "maximum": 30,
          "minimum": 16,
          "type": "integer"
        }
      },
      "required": [
        "bootconfig",
        "id"
      ]
    },
    "v1.PartitionUpdateRequest": {
      "properties": {
        "bootconfig": {
          "$ref": "#/definitions/v1.PartitionBootConfiguration",
          "description": "the boot configuration of this partition"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "free labels that you associate with this partition",
          "type": "object"
        },
        "mgmtserviceaddress": {
          "description": "the address to the management service of this partition",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        }
      },
      "required": [
        "id"
      ]
    },
    "v1.PowerMetric": {
      "properties": {
        "averageconsumedwatts": {
          "format": "float",
          "type": "number"
        },
        "intervalinmin": {
          "format": "float",
          "type": "number"
        },
        "maxconsumedwatts": {
          "format": "float",
          "type": "number"
        },
        "minconsumedwatts": {
          "format": "float",
          "type": "number"
        }
      },
      "required": [
        "averageconsumedwatts",
        "intervalinmin",
        "maxconsumedwatts",
        "minconsumedwatts"
      ]
    },
    "v1.PowerSupply": {
      "properties": {
        "status": {
          "$ref": "#/definitions/v1.PowerSupplyStatus"
        }
      },
      "required": [
        "status"
      ]
    },
    "v1.PowerSupplyStatus": {
      "properties": {
        "health": {
          "type": "string"
        },
        "state": {
          "type": "string"
        }
      },
      "required": [
        "health",
        "state"
      ]
    },
    "v1.Project": {
      "properties": {
        "description": {
          "type": "string"
        },
        "meta": {
          "$ref": "#/definitions/v1.Meta"
        },
        "name": {
          "type": "string"
        },
        "quotas": {
          "$ref": "#/definitions/v1.QuotaSet"
        },
        "tenant_id": {
          "type": "string"
        }
      }
    },
    "v1.ProjectCreateRequest": {
      "properties": {
        "description": {
          "type": "string"
        },
        "meta": {
          "$ref": "#/definitions/v1.Meta"
        },
        "name": {
          "type": "string"
        },
        "quotas": {
          "$ref": "#/definitions/v1.QuotaSet"
        },
        "tenant_id": {
          "type": "string"
        }
      }
    },
    "v1.ProjectFindRequest": {
      "properties": {
        "description": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "tenant_id": {
          "type": "string"
        }
      }
    },
    "v1.ProjectResponse": {
      "properties": {
        "description": {
          "type": "string"
        },
        "meta": {
          "$ref": "#/definitions/v1.Meta"
        },
        "name": {
          "type": "string"
        },
        "quotas": {
          "$ref": "#/definitions/v1.QuotaSet"
        },
        "tenant_id": {
          "type": "string"
        }
      }
    },
    "v1.ProjectUpdateRequest": {
      "properties": {
        "description": {
          "type": "string"
        },
        "meta": {
          "$ref": "#/definitions/v1.Meta"
        },
        "name": {
          "type": "string"
        },
        "quotas": {
          "$ref": "#/definitions/v1.QuotaSet"
        },
        "tenant_id": {
          "type": "string"
        }
      }
    },
    "v1.Quota": {
      "properties": {
        "quota": {
          "format": "int32",
          "type": "integer"
        },
        "used": {
          "format": "int32",
          "type": "integer"
        }
      }
    },
    "v1.QuotaSet": {
      "properties": {
        "cluster": {
          "$ref": "#/definitions/v1.Quota"
        },
        "ip": {
          "$ref": "#/definitions/v1.Quota"
        },
        "machine": {
          "$ref": "#/definitions/v1.Quota"
        },
        "project": {
          "$ref": "#/definitions/v1.Quota"
        }
      }
    },
    "v1.Raid": {
      "properties": {
        "arrayname": {
          "description": "the name of the resulting array device",
          "type": "string"
        },
        "createoptions": {
          "description": "the options to use to create the raid array",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "devices": {
          "description": "list of devices to form the raid array from",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "level": {
          "description": "raid level to create, should be 0 or 1",
          "type": "string"
        },
        "spares": {
          "description": "number of spares for the raid array",
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "arrayname",
        "level",
        "spares"
      ]
    },
    "v1.ServerCapacity": {
      "properties": {
        "allocatable": {
          "description": "free machines with this size, size reservations are not considered",
          "format": "int32",
          "type": "integer"
        },
        "allocated": {
          "description": "allocated machines",
          "format": "int32",
          "type": "integer"
        },
        "faulty": {
          "description": "machines with issues with this size",
          "format": "int32",
          "type": "integer"
        },
        "faultymachines": {
          "description": "machine ids with issues with this size",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "free": {
          "description": "free machines with this size (freely allocatable)",
          "format": "int32",
          "type": "integer"
        },
        "other": {
          "description": "machines neither phoned home nor waiting but in another provisioning state",
          "format": "int32",
          "type": "integer"
        },
        "othermachines": {
          "description": "machine ids neither allocated nor waiting with this size",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "phoned_home": {
          "description": "machines in phoned home provisioning state",
          "format": "int32",
          "type": "integer"
        },
        "remainingreservations": {
          "description": "the amount of unused / remaining / open reservations for this size",
          "format": "int32",
          "type": "integer"
        },
        "reservations": {
          "description": "the amount of reservations for this size",
          "format": "int32",
          "type": "integer"
        },
        "size": {
          "description": "the size of the machine",
          "type": "string"
        },
        "total": {
          "description": "total amount of machines with size",
          "format": "int32",
          "type": "integer"
        },
        "unavailable": {
          "description": "unavailable machines with this size",
          "format": "int32",
          "type": "integer"
        },
        "usedreservations": {
          "description": "the amount of used reservations for this size",
          "format": "int32",
          "type": "integer"
        },
        "waiting": {
          "description": "machines in waiting provisioning state",
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "size"
      ]
    },
    "v1.SizeConstraint": {
      "description": "a machine matches to a size in order to make them easier to categorize",
      "properties": {
        "identifier": {
          "description": "glob pattern which matches to the given type, for example gpu pci id",
          "type": "string"
        },
        "max": {
          "description": "the maximum value of the constraint",
          "format": "integer",
          "type": "integer"
        },
        "min": {
          "description": "the minimum value of the constraint",
          "format": "integer",
          "type": "integer"
        },
        "type": {
          "description": "the type of the constraint",
          "enum": [
            "cores",
            "gpu",
            "memory",
            "storage"
          ],
          "type": "string"
        }
      },
      "required": [
        "type"
      ]
    },
    "v1.SizeCreateRequest": {
      "properties": {
        "constraints": {
          "description": "a list of constraints that defines this size",
          "items": {
            "$ref": "#/definitions/v1.SizeConstraint"
          },
          "type": "array"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "free labels that you associate with this size.",
          "type": "object"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        }
      },
      "required": [
        "constraints",
        "id"
      ]
    },
    "v1.SizeImageConstraintBase": {
      "properties": {
        "images": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "a list of images for this constraints apply",
          "type": "object"
        }
      },
      "required": [
        "images"
      ]
    },
    "v1.SizeImageConstraintCreateRequest": {
      "properties": {
        "constraints": {
          "$ref": "#/definitions/v1.SizeImageConstraintBase",
          "description": "a list of constraints that for this size"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        }
      },
      "required": [
        "id"
      ]
    },
    "v1.SizeImageConstraintResponse": {
      "properties": {
        "constraints": {
          "$ref": "#/definitions/v1.SizeImageConstraintBase",
          "description": "a list of constraints that for this size"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        }
      },
      "required": [
        "constraints",
        "id"
      ]
    },
    "v1.SizeImageConstraintTryRequest": {
      "properties": {
        "image": {
          "type": "string"
        },
        "size": {
          "type": "string"
        }
      },
      "required": [
        "image",
        "size"
      ]
    },
    "v1.SizeImageConstraintUpdateRequest": {
      "properties": {
        "constraints": {
          "$ref": "#/definitions/v1.SizeImageConstraintBase",
          "description": "a list of constraints that for this size"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        }
      },
      "required": [
        "id"
      ]
    },
    "v1.SizeReservationCreateRequest": {
      "properties": {
        "amount": {
          "description": "the amount of reservations of this size reservation",
          "format": "int32",
          "type": "integer"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "free labels associated with this size reservation.",
          "type": "object"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "partitionids": {
          "description": "the partition id of this size reservation",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "projectid": {
          "description": "the project id of this size reservation",
          "type": "string"
        },
        "sizeid": {
          "description": "the size id of this size reservation",
          "type": "string"
        }
      },
      "required": [
        "amount",
        "id",
        "partitionids",
        "projectid",
        "sizeid"
      ]
    },
    "v1.SizeReservationListRequest": {
      "properties": {
        "id": {
          "description": "the id of this size reservation",
          "type": "string"
        },
        "partitionid": {
          "description": "the partition id of this size reservation",
          "type": "string"
        },
        "projectid": {
          "description": "the project id of this size reservation",
          "type": "string"
        },
        "sizeid": {
          "description": "the size id of this size reservation",
          "type": "string"
        }
      }
    },
    "v1.SizeReservationResponse": {
      "properties": {
        "amount": {
          "description": "the amount of reservations of this size reservation",
          "format": "int32",
          "type": "integer"
        },
        "changed": {
          "description": "the last changed timestamp of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "created": {
          "description": "the creation time of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "free labels associated with this size reservation.",
          "type": "object"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "partitionids": {
          "description": "the partition id of this size reservation",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "projectid": {
          "description": "the project id of this size reservation",
          "type": "string"
        },
        "sizeid": {
          "description": "the size id of this size reservation",
          "type": "string"
        }
      },
      "required": [
        "amount",
        "id",
        "partitionids",
        "projectid",
        "sizeid"
      ]
    },
    "v1.SizeReservationUpdateRequest": {
      "properties": {
        "amount": {
          "description": "the amount of reservations of this size reservation",
          "format": "int32",
          "type": "integer"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "free labels associated with this size reservation.",
          "type": "object"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "partitionids": {
          "description": "the partition id of this size reservation",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "amount",
        "id",
        "partitionids"
      ]
    },
    "v1.SizeReservationUsageResponse": {
      "properties": {
        "amount": {
          "description": "the amount of reservations of this size reservation",
          "format": "int32",
          "type": "integer"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "free labels associated with this size reservation.",
          "type": "object"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "partitionid": {
          "description": "the partition id of this size reservation",
          "type": "string"
        },
        "projectallocations": {
          "description": "the amount of allocations of this project referenced by this size reservation",
          "format": "int32",
          "type": "integer"
        },
        "projectid": {
          "description": "the project id of this size reservation",
          "type": "string"
        },
        "sizeid": {
          "description": "the size id of this size reservation",
          "type": "string"
        },
        "usedamount": {
          "description": "the used amount of reservations of this size reservation",
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "amount",
        "id",
        "partitionid",
        "projectallocations",
        "projectid",
        "sizeid",
        "usedamount"
      ]
    },
    "v1.SizeResponse": {
      "properties": {
        "changed": {
          "description": "the last changed timestamp of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "constraints": {
          "description": "a list of constraints that defines this size",
          "items": {
            "$ref": "#/definitions/v1.SizeConstraint"
          },
          "type": "array"
        },
        "created": {
          "description": "the creation time of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "free labels that you associate with this size.",
          "type": "object"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        }
      },
      "required": [
        "constraints",
        "id",
        "labels"
      ]
    },
    "v1.SizeSuggestRequest": {
      "properties": {
        "machineID": {
          "description": "machineID to retrieve size suggestion for",
          "type": "string"
        }
      },
      "required": [
        "machineID"
      ]
    },
    "v1.SizeUpdateRequest": {
      "properties": {
        "constraints": {
          "description": "a list of constraints that defines this size",
          "items": {
            "$ref": "#/definitions/v1.SizeConstraint"
          },
          "type": "array"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "free labels that you associate with this size.",
          "type": "object"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        }
      },
      "required": [
        "id"
      ]
    },
    "v1.SwitchBase": {
      "description": "A switch that can register at the api.",
      "properties": {
        "console_command": {
          "description": "command to access the console of the switch",
          "type": "string"
        },
        "management_ip": {
          "description": "the ip address of the management interface of the switch",
          "type": "string"
        },
        "management_user": {
          "description": "the user to connect to the switch",
          "type": "string"
        },
        "mode": {
          "description": "the mode the switch currently has",
          "type": "string"
        },
        "os": {
          "$ref": "#/definitions/v1.SwitchOS",
          "description": "the operating system the switch currently has"
        },
        "rack_id": {
          "description": "the id of the rack in which this switch is located",
          "type": "string"
        }
      },
      "required": [
        "rack_id"
      ]
    },
    "v1.SwitchConnection": {
      "properties": {
        "machine_id": {
          "description": "the machine id of the machine connected to the nic",
          "type": "string"
        },
        "nic": {
          "$ref": "#/definitions/v1.SwitchNic",
          "description": "a network interface on the switch"
        }
      },
      "required": [
        "nic"
      ]
    },
    "v1.SwitchFindRequest": {
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "osvendor": {
          "type": "string"
        },
        "osversion": {
          "type": "string"
        },
        "partitionid": {
          "type": "string"
        },
        "rackid": {
          "type": "string"
        }
      }
    },
    "v1.SwitchNic": {
      "properties": {
        "actual": {
          "description": "the current state of the nic",
          "enum": [
            "DOWN",
            "UNKNOWN",
            "UP"
          ],
          "type": "string"
        },
        "filter": {
          "$ref": "#/definitions/v1.BGPFilter",
          "description": "configures the bgp filter applied at the switch port"
        },
        "identifier": {
          "description": "the identifier of this network interface",
          "type": "string"
        },
        "mac": {
          "description": "the mac address of this network interface",
          "type": "string"
        },
        "name": {
          "description": "the name of this network interface",
          "type": "string"
        },
        "vrf": {
          "description": "the vrf this network interface is part of",
          "type": "string"
        }
      },
      "required": [
        "actual",
        "identifier",
        "mac",
        "name"
      ]
    },
    "v1.SwitchNotifyRequest": {
      "properties": {
        "error": {
          "type": "string"
        },
        "port_states": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "the current switch port states",
          "type": "object"
        },
        "sync_duration": {
          "description": "the duration of the switch synchronization",
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "error",
        "port_states",
        "sync_duration"
      ]
    },
    "v1.SwitchNotifyResponse": {
      "properties": {
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "last_sync": {
          "$ref": "#/definitions/v1.SwitchSync",
          "description": "last successful synchronization to the switch"
        },
        "last_sync_error": {
          "$ref": "#/definitions/v1.SwitchSync",
          "description": "last synchronization to the switch that was erroneous"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        }
      },
      "required": [
        "id"
      ]
    },
    "v1.SwitchOS": {
      "properties": {
        "metal_core_version": {
          "description": "the version of metal-core running",
          "type": "string"
        },
        "vendor": {
          "description": "the operating system vendor the switch currently has",
          "type": "string"
        },
        "version": {
          "description": "the operating system version the switch currently has",
          "type": "string"
        }
      }
    },
    "v1.SwitchPortToggleRequest": {
      "properties": {
        "nic": {
          "description": "the nic of the switch you want to change",
          "type": "string"
        },
        "status": {
          "description": "sets the port status",
          "enum": [
            "DOWN",
            "UP"
          ],
          "type": "string"
        }
      },
      "required": [
        "nic",
        "status"
      ]
    },
    "v1.SwitchRegisterRequest": {
      "properties": {
        "console_command": {
          "description": "command to access the console of the switch",
          "type": "string"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "management_ip": {
          "description": "the ip address of the management interface of the switch",
          "type": "string"
        },
        "management_user": {
          "description": "the user to connect to the switch",
          "type": "string"
        },
        "mode": {
          "description": "the mode the switch currently has",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "nics": {
          "description": "the list of network interfaces on the switch",
          "items": {
            "$ref": "#/definitions/v1.SwitchNic"
          },
          "type": "array"
        },
        "os": {
          "$ref": "#/definitions/v1.SwitchOS",
          "description": "the operating system the switch currently has"
        },
        "partition_id": {
          "description": "the partition in which this switch is located",
          "type": "string"
        },
        "rack_id": {
          "description": "the id of the rack in which this switch is located",
          "type": "string"
        }
      },
      "required": [
        "id",
        "nics",
        "partition_id",
        "rack_id"
      ]
    },
    "v1.SwitchResponse": {
      "properties": {
        "changed": {
          "description": "the last changed timestamp of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "connections": {
          "description": "a connection between a switch port and a machine with the real nic states",
          "items": {
            "$ref": "#/definitions/v1.SwitchConnection"
          },
          "type": "array"
        },
        "console_command": {
          "description": "command to access the console of the switch",
          "type": "string"
        },
        "created": {
          "description": "the creation time of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "last_sync": {
          "$ref": "#/definitions/v1.SwitchSync",
          "description": "last successful synchronization to the switch"
        },
        "last_sync_error": {
          "$ref": "#/definitions/v1.SwitchSync",
          "description": "last synchronization to the switch that was erroneous"
        },
        "management_ip": {
          "description": "the ip address of the management interface of the switch",
          "type": "string"
        },
        "management_user": {
          "description": "the user to connect to the switch",
          "type": "string"
        },
        "mode": {
          "description": "the mode the switch currently has",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "nics": {
          "description": "the list of network interfaces on the switch with the desired nic states",
          "items": {
            "$ref": "#/definitions/v1.SwitchNic"
          },
          "type": "array"
        },
        "os": {
          "$ref": "#/definitions/v1.SwitchOS",
          "description": "the operating system the switch currently has"
        },
        "partition": {
          "$ref": "#/definitions/v1.PartitionResponse",
          "description": "the partition in which this switch is located"
        },
        "rack_id": {
          "description": "the id of the rack in which this switch is located",
          "type": "string"
        }
      },
      "required": [
        "connections",
        "id",
        "nics",
        "partition",
        "rack_id"
      ]
    },
    "v1.SwitchSync": {
      "properties": {
        "duration": {
          "description": "the duration that lat switch sync took",
          "format": "int64",
          "type": "integer"
        },
        "error": {
          "description": "shows the error occurred during the sync",
          "type": "string"
        },
        "time": {
          "description": "point in time when the last switch sync happened",
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "duration",
        "time"
      ]
    },
    "v1.SwitchUpdateRequest": {
      "properties": {
        "console_command": {
          "description": "command to access the console of the switch",
          "type": "string"
        },
        "description": {
          "description": "a description for this entity",
          "type": "string"
        },
        "id": {
          "description": "the unique ID of this entity",
          "type": "string"
        },
        "management_ip": {
          "description": "the ip address of the management interface of the switch",
          "type": "string"
        },
        "management_user": {
          "description": "the user to connect to the switch",
          "type": "string"
        },
        "mode": {
          "description": "the mode the switch currently has",
          "type": "string"
        },
        "name": {
          "description": "a readable name for this entity",
          "type": "string"
        },
        "os": {
          "$ref": "#/definitions/v1.SwitchOS",
          "description": "the operating system the switch currently has"
        },
        "rack_id": {
          "description": "the id of the rack in which this switch is located",
          "type": "string"
        }
      },
      "required": [
        "id",
        "rack_id"
      ]
    },
    "v1.Tenant": {
      "properties": {
        "default_quotas": {
          "$ref": "#/definitions/v1.QuotaSet"
        },
        "description": {
          "type": "string"
        },
        "iam_config": {
          "$ref": "#/definitions/v1.IAMConfig"
        },
        "meta": {
          "$ref": "#/definitions/v1.Meta"
        },
        "name": {
          "type": "string"
        },
        "quotas": {
          "$ref": "#/definitions/v1.QuotaSet"
        }
      }
    },
    "v1.TenantCreateRequest": {
      "properties": {
        "default_quotas": {
          "$ref": "#/definitions/v1.QuotaSet"
        },
        "description": {
          "type": "string"
        },
        "iam_config": {
          "$ref": "#/definitions/v1.IAMConfig"
        },
        "meta": {
          "$ref": "#/definitions/v1.Meta"
        },
        "name": {
          "type": "string"
        },
        "quotas": {
          "$ref": "#/definitions/v1.QuotaSet"
        }
      }
    },
    "v1.TenantFindRequest": {
      "properties": {
        "annotations": {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "paging": {
          "$ref": "#/definitions/v1.Paging"
        }
      }
    },
    "v1.TenantResponse": {
      "properties": {
        "default_quotas": {
          "$ref": "#/definitions/v1.QuotaSet"
        },
        "description": {
          "type": "string"
        },
        "iam_config": {
          "$ref": "#/definitions/v1.IAMConfig"
        },
        "meta": {
          "$ref": "#/definitions/v1.Meta"
        },
        "name": {
          "type": "string"
        },
        "quotas": {
          "$ref": "#/definitions/v1.QuotaSet"
        }
      }
    },
    "v1.TenantUpdateRequest": {
      "properties": {
        "default_quotas": {
          "$ref": "#/definitions/v1.QuotaSet"
        },
        "description": {
          "type": "string"
        },
        "iam_config": {
          "$ref": "#/definitions/v1.IAMConfig"
        },
        "meta": {
          "$ref": "#/definitions/v1.Meta"
        },
        "name": {
          "type": "string"
        },
        "quotas": {
          "$ref": "#/definitions/v1.QuotaSet"
        }
      }
    },
    "v1.Timestamps": {
      "properties": {
        "changed": {
          "description": "the last changed timestamp of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "created": {
          "description": "the creation time of this entity",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        }
      }
    },
    "v1.User": {
      "properties": {
        "EMail": {
          "type": "string"
        },
        "Groups": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "Issuer": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "Subject": {
          "type": "string"
        },
        "Tenant": {
          "type": "string"
        }
      },
      "required": [
        "EMail",
        "Groups",
        "Issuer",
        "Name",
        "Subject",
        "Tenant"
      ]
    },
    "v1.VPNRequest": {
      "properties": {
        "ephemeral": {
          "description": "specifies if auth key should be ephemeral",
          "type": "boolean"
        },
        "expiration": {
          "description": "expiration time",
          "format": "int64",
          "type": "integer"
        },
        "pid": {
          "description": "project ID",
          "type": "string"
        }
      },
      "required": [
        "ephemeral",
        "pid"
      ]
    },
    "v1.VPNResponse": {
      "properties": {
        "address": {
          "description": "address of VPN's control plane",
          "type": "string"
        },
        "auth_key": {
          "description": "auth key to connect to the VPN",
          "type": "string"
        }
      },
      "required": [
        "address",
        "auth_key"
      ]
    },
    "v1.VendorRevisions": {
      "properties": {
        "VendorRevisions": {
          "additionalProperties": {
            "$ref": "#/definitions/v1.BoardRevisions"
          },
          "type": "object"
        }
      },
      "required": [
        "VendorRevisions"
      ]
    },
    "v1.VolumeGroup": {
      "properties": {
        "devices": {
          "description": "list of devices to form the volume group from",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "name": {
          "description": "the name of the resulting volume group",
          "type": "string"
        },
        "tags": {
          "description": "list of tags to add to the volume group",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "name"
      ]
    }
  },
  "info": {
    "contact": {
      "name": "metal-stack",
      "url": "https://metal-stack.io"
    },
    "description": "API to manage and control plane resources like machines, switches, operating system images, machine sizes, networks, IP addresses and more",
    "license": {
      "name": "AGPL-3.0",
      "url": "https://www.gnu.org/licenses/agpl-3.0.de.html"
    },
    "title": "metal-api",
    "version": "v0.37.2"
  },
  "paths": {
    "/v1/audit/find": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findAuditTraces",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.AuditFindRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.AuditResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "find all audit traces that match given properties",
        "tags": [
          "audit"
        ]
      }
    },
    "/v1/filesystemlayout": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "listFilesystemLayouts",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.FilesystemLayoutResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all filesystemlayouts",
        "tags": [
          "filesystemlayout"
        ]
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "updateFilesystemLayout",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.FilesystemLayoutUpdateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.FilesystemLayoutResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "updates a filesystemlayout. if the filesystemlayout was changed since this one was read, a conflict is returned",
        "tags": [
          "filesystemlayout"
        ]
      },
      "put": {
        "consumes": [
          "application/json"
        ],
        "operationId": "createFilesystemLayout",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.FilesystemLayoutCreateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/v1.FilesystemLayoutResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "create a filesystemlayout. if the given ID already exists a conflict is returned",
        "tags": [
          "filesystemlayout"
        ]
      }
    },
    "/v1/filesystemlayout/matches": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "matchFilesystemLayout",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.FilesystemLayoutMatchRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.FilesystemLayoutResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "check if the given machine id satisfies the disk requirements of the filesystemlayout in question",
        "tags": [
          "filesystemlayout"
        ]
      }
    },
    "/v1/filesystemlayout/try": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "tryFilesystemLayout",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.FilesystemLayoutTryRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.FilesystemLayoutResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "try to detect a filesystemlayout based on given size and image.",
        "tags": [
          "filesystemlayout"
        ]
      }
    },
    "/v1/filesystemlayout/{id}": {
      "delete": {
        "consumes": [
          "application/json"
        ],
        "operationId": "deleteFilesystemLayout",
        "parameters": [
          {
            "description": "identifier of the filesystemlayout",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.FilesystemLayoutResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "deletes an filesystemlayout and returns the deleted entity",
        "tags": [
          "filesystemlayout"
        ]
      },
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "getFilesystemLayout",
        "parameters": [
          {
            "description": "identifier of the filesystemlayout",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.FilesystemLayoutResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get filesystemlayout by id",
        "tags": [
          "filesystemlayout"
        ]
      }
    },
    "/v1/firewall": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "listFirewalls",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.FirewallResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all known firewalls",
        "tags": [
          "firewall"
        ]
      }
    },
    "/v1/firewall/allocate": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "allocateFirewall",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.FirewallCreateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.FirewallResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "allocate a firewall",
        "tags": [
          "firewall"
        ]
      }
    },
    "/v1/firewall/find": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findFirewalls",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.FirewallFindRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.FirewallResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "find firewalls by multiple criteria",
        "tags": [
          "firewall"
        ]
      }
    },
    "/v1/firewall/{id}": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findFirewall",
        "parameters": [
          {
            "description": "identifier of the firewall",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.FirewallResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get firewall by id",
        "tags": [
          "firewall"
        ]
      }
    },
    "/v1/firmware": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "listFirmwares",
        "parameters": [
          {
            "description": "restrict firmwares to the given machine",
            "in": "query",
            "name": "machine-id",
            "type": "string"
          },
          {
            "description": "the firmware kind [bios|bmc]",
            "in": "query",
            "name": "kind",
            "type": "string"
          },
          {
            "description": "the vendor",
            "in": "query",
            "name": "vendor",
            "type": "string"
          },
          {
            "description": "the board",
            "in": "query",
            "name": "board",
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.FirmwaresResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "returns all firmwares (for a specific machine)",
        "tags": [
          "firmware"
        ]
      }
    },
    "/v1/firmware/{kind}/{vendor}/{board}/{revision}": {
      "delete": {
        "consumes": [
          "application/json"
        ],
        "operationId": "removeFirmware",
        "parameters": [
          {
            "description": "the firmware kind [bios|bmc]",
            "in": "path",
            "name": "kind",
            "required": true,
            "type": "string"
          },
          {
            "description": "the vendor",
            "in": "path",
            "name": "vendor",
            "required": true,
            "type": "string"
          },
          {
            "description": "the board",
            "in": "path",
            "name": "board",
            "required": true,
            "type": "string"
          },
          {
            "description": "the firmware revision",
            "in": "path",
            "name": "revision",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.EmptyBody"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "remove given firmware",
        "tags": [
          "firmware"
        ]
      },
      "put": {
        "consumes": [
          "multipart/form-data"
        ],
        "operationId": "uploadFirmware",
        "parameters": [
          {
            "description": "the firmware kind [bios|bmc]",
            "in": "path",
            "name": "kind",
            "required": true,
            "type": "string"
          },
          {
            "description": "the vendor",
            "in": "path",
            "name": "vendor",
            "required": true,
            "type": "string"
          },
          {
            "description": "the board",
            "in": "path",
            "name": "board",
            "required": true,
            "type": "string"
          },
          {
            "description": "the firmware revision",
            "in": "path",
            "name": "revision",
            "required": true,
            "type": "string"
          },
          {
            "description": "the firmware file",
            "in": "formData",
            "name": "file",
            "type": "file"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "upload given firmware",
        "tags": [
          "firmware"
        ]
      }
    },
    "/v1/health": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "health",
        "parameters": [
          {
            "description": "return health for this specific service only",
            "in": "query",
            "name": "service",
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/rest.HealthResponse"
            }
          },
          "500": {
            "description": "Unhealthy",
            "schema": {
              "$ref": "#/definitions/rest.HealthResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "perform a healthcheck",
        "tags": [
          "health"
        ]
      }
    },
    "/v1/image": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "listImages",
        "parameters": [
          {
            "default": false,
            "description": "include image usage into response",
            "in": "query",
            "name": "show-usage",
            "type": "boolean"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.ImageResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all images",
        "tags": [
          "image"
        ]
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "updateImage",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.ImageUpdateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.ImageResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "updates an image. if the image was changed since this one was read, a conflict is returned",
        "tags": [
          "image"
        ]
      },
      "put": {
        "consumes": [
          "application/json"
        ],
        "operationId": "createImage",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.ImageCreateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/v1.ImageResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "create an image. if the given ID already exists a conflict is returned",
        "tags": [
          "image"
        ]
      }
    },
    "/v1/image/find": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findImages",
        "parameters": [
          {
            "default": false,
            "description": "include image usage into response",
            "in": "query",
            "name": "show-usage",
            "type": "boolean"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.ImageFindRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.ImageResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all images that match given properties",
        "tags": [
          "image"
        ]
      }
    },
    "/v1/image/{id}": {
      "delete": {
        "consumes": [
          "application/json"
        ],
        "operationId": "deleteImage",
        "parameters": [
          {
            "description": "identifier of the image",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.ImageResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "deletes an image and returns the deleted entity",
        "tags": [
          "image"
        ]
      },
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findImage",
        "parameters": [
          {
            "description": "identifier of the image",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.ImageResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get image by id",
        "tags": [
          "image"
        ]
      }
    },
    "/v1/image/{id}/latest": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findLatestImage",
        "parameters": [
          {
            "description": "identifier of the image",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.ImageResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "find latest image by id",
        "tags": [
          "image"
        ]
      }
    },
    "/v1/image/{id}/query": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "queryImages by id",
        "parameters": [
          {
            "description": "identifier of the image",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.ImageResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "query all images which match at least id",
        "tags": [
          "image"
        ]
      }
    },
    "/v1/ip": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "listIPs",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.IPResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all ips",
        "tags": [
          "ip"
        ]
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "updateIP",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.IPUpdateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.IPResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "updates an ip. if the ip was changed since this one was read, a conflict is returned",
        "tags": [
          "ip"
        ]
      }
    },
    "/v1/ip/allocate": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "allocateIP",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.IPAllocateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/v1.IPResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "allocate an ip in the given network.",
        "tags": [
          "ip"
        ]
      }
    },
    "/v1/ip/allocate/{ip}": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "allocateSpecificIP",
        "parameters": [
          {
            "description": "ip to try to allocate",
            "in": "path",
            "name": "ip",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.IPAllocateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/v1.IPResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "allocate a specific ip in the given network.",
        "tags": [
          "ip"
        ]
      }
    },
    "/v1/ip/find": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findIPs",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.IPFindRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.IPResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all ips that match given properties",
        "tags": [
          "ip"
        ]
      }
    },
    "/v1/ip/free/{id}": {
      "delete": {
        "consumes": [
          "application/json"
        ],
        "operationId": "freeIP",
        "parameters": [
          {
            "description": "identifier of the ip",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.IPResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "frees an ip",
        "tags": [
          "ip"
        ]
      }
    },
    "/v1/ip/{id}": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findIP",
        "parameters": [
          {
            "description": "identifier of the ip",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.IPResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get ip by id",
        "tags": [
          "ip"
        ]
      }
    },
    "/v1/machine": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "listMachines",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.MachineResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all known machines",
        "tags": [
          "machine"
        ]
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "updateMachine",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.MachineUpdateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "updates a machine. if the machine was changed since this one was read, a conflict is returned",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/allocate": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "allocateMachine",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.MachineAllocateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "allocate a machine",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/consolepassword": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "getMachineConsolePassword",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.MachineConsolePasswordRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineConsolePasswordResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get consolepassword for machine by id",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/find": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findMachines",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.MachineFindRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.MachineResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "find machines by multiple criteria",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/ipmi": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "ipmiReport",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.MachineIpmiReports"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineIpmiReportResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "reports IPMI ip addresses leased by a management server for machines",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/ipmi/find": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findIPMIMachines",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.MachineFindRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.MachineIPMIResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "returns machines including the ipmi connection data",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/issues": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "listIssues",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.MachineIssue"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "returns the list of issues that exist in the API",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/issues/evaluate": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "issues",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.MachineIssuesRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.MachineIssueResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "returns machine issues",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/update-firmware/{id}": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "updateFirmware",
        "parameters": [
          {
            "description": "identifier of the machine",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.MachineUpdateFirmwareRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "sends a firmware command to the machine",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/{id}": {
      "delete": {
        "consumes": [
          "application/json"
        ],
        "operationId": "deleteMachine",
        "parameters": [
          {
            "description": "identifier of the machine",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "deletes a machine from the database",
        "tags": [
          "machine"
        ]
      },
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findMachine",
        "parameters": [
          {
            "description": "identifier of the machine",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get machine by id",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/{id}/free": {
      "delete": {
        "consumes": [
          "application/json"
        ],
        "operationId": "freeMachine",
        "parameters": [
          {
            "description": "identifier of the machine",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "free a machine",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/{id}/ipmi": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findIPMIMachine",
        "parameters": [
          {
            "description": "identifier of the machine",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineIPMIResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "returns a machine including the ipmi connection data",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/{id}/power/bios": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "machineBios",
        "parameters": [
          {
            "description": "identifier of the machine",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.EmptyBody"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "boots machine into BIOS",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/{id}/power/chassis-identify-led-off": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "chassisIdentifyLEDOff",
        "parameters": [
          {
            "description": "identifier of the machine",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "description": "reason why the chassis identify LED has been turned off",
            "in": "query",
            "name": "description",
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.EmptyBody"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "sends a power-off to the chassis identify LED",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/{id}/power/chassis-identify-led-on": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "chassisIdentifyLEDOn",
        "parameters": [
          {
            "description": "identifier of the machine",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "description": "identifier of the machine",
            "in": "query",
            "name": "description",
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.EmptyBody"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "sends a power-on to the chassis identify LED",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/{id}/power/cycle": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "machineCycle",
        "parameters": [
          {
            "description": "identifier of the machine",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.EmptyBody"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "sends a power cycle to the machine",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/{id}/power/disk": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "machineDisk",
        "parameters": [
          {
            "description": "identifier of the machine",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.EmptyBody"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "boots machine from disk",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/{id}/power/off": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "machineOff",
        "parameters": [
          {
            "description": "identifier of the machine",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.EmptyBody"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "sends a power-off to the machine",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/{id}/power/on": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "machineOn",
        "parameters": [
          {
            "description": "identifier of the machine",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.EmptyBody"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "sends a power-on to the machine",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/{id}/power/pxe": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "machinePxe",
        "parameters": [
          {
            "description": "identifier of the machine",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.EmptyBody"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "boots machine from PXE",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/{id}/power/reset": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "machineReset",
        "parameters": [
          {
            "description": "identifier of the machine",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.EmptyBody"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "sends a reset to the machine",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/{id}/reinstall": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "reinstallMachine",
        "parameters": [
          {
            "description": "identifier of the machine",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.MachineReinstallRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineResponse"
            }
          },
          "400": {
            "description": "Bad Request",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "reinstall this machine",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/machine/{id}/state": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "setMachineState",
        "parameters": [
          {
            "description": "identifier of the machine",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.MachineState"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.MachineResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "set the state of a machine",
        "tags": [
          "machine"
        ]
      }
    },
    "/v1/network": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "listNetworks",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.NetworkResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all networks",
        "tags": [
          "network"
        ]
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "updateNetwork",
        "parameters": [
          {
            "default": false,
            "description": "if true update forcefully",
            "in": "query",
            "name": "force",
            "type": "boolean"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.NetworkUpdateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.NetworkResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "updates a network. if the network was changed since this one was read, a conflict is returned",
        "tags": [
          "network"
        ]
      },
      "put": {
        "consumes": [
          "application/json"
        ],
        "operationId": "createNetwork",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.NetworkCreateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/v1.NetworkResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "create a network. if the given ID already exists a conflict is returned",
        "tags": [
          "network"
        ]
      }
    },
    "/v1/network/allocate": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "allocateNetwork",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.NetworkAllocateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/v1.NetworkResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "allocates a child network from a partition's private super network",
        "tags": [
          "network"
        ]
      }
    },
    "/v1/network/find": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findNetworks",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.NetworkFindRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.NetworkResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all networks that match given properties",
        "tags": [
          "network"
        ]
      }
    },
    "/v1/network/free/{id}": {
      "delete": {
        "consumes": [
          "application/json"
        ],
        "operationId": "freeNetwork",
        "parameters": [
          {
            "description": "identifier of the network",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.NetworkResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "free a network",
        "tags": [
          "network"
        ]
      },
      "post": {
        "consumes": [
          "*/*",
          "application/json"
        ],
        "deprecated": true,
        "operationId": "freeNetworkDeprecated",
        "parameters": [
          {
            "description": "identifier of the network",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.NetworkResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "free a network",
        "tags": [
          "network"
        ]
      }
    },
    "/v1/network/{id}": {
      "delete": {
        "consumes": [
          "application/json"
        ],
        "operationId": "deleteNetwork",
        "parameters": [
          {
            "description": "identifier of the network",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.NetworkResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "deletes a network and returns the deleted entity",
        "tags": [
          "network"
        ]
      },
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findNetwork",
        "parameters": [
          {
            "description": "identifier of the network",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.NetworkResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get network by id",
        "tags": [
          "network"
        ]
      }
    },
    "/v1/partition": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "listPartitions",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.PartitionResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all Partitions",
        "tags": [
          "Partition"
        ]
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "updatePartition",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.PartitionUpdateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.PartitionResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "updates a Partition. if the Partition was changed since this one was read, a conflict is returned",
        "tags": [
          "Partition"
        ]
      },
      "put": {
        "consumes": [
          "application/json"
        ],
        "operationId": "createPartition",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.PartitionCreateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/v1.PartitionResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "create a Partition. if the given ID already exists a conflict is returned",
        "tags": [
          "Partition"
        ]
      }
    },
    "/v1/partition/capacity": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "partitionCapacity",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.PartitionCapacityRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.PartitionCapacity"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get partition capacity",
        "tags": [
          "Partition"
        ]
      }
    },
    "/v1/partition/{id}": {
      "delete": {
        "consumes": [
          "application/json"
        ],
        "operationId": "deletePartition",
        "parameters": [
          {
            "description": "identifier of the Partition",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.PartitionResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "deletes a Partition and returns the deleted entity",
        "tags": [
          "Partition"
        ]
      },
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findPartition",
        "parameters": [
          {
            "description": "identifier of the Partition",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.PartitionResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get Partition by id",
        "tags": [
          "Partition"
        ]
      }
    },
    "/v1/project": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "listProjects",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.ProjectResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all projects",
        "tags": [
          "project"
        ]
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "updateProject",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.ProjectUpdateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Updated",
            "schema": {
              "$ref": "#/definitions/v1.ProjectResponse"
            }
          },
          "412": {
            "description": "OptimisticLock",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "update a project. optimistic lock error can occur.",
        "tags": [
          "project"
        ]
      },
      "put": {
        "consumes": [
          "application/json"
        ],
        "operationId": "createProject",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.ProjectCreateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/v1.ProjectResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "create a project. if the given ID already exists a conflict is returned",
        "tags": [
          "project"
        ]
      }
    },
    "/v1/project/find": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findProjects",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.ProjectFindRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.ProjectResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all projects that match given properties",
        "tags": [
          "project"
        ]
      }
    },
    "/v1/project/{id}": {
      "delete": {
        "consumes": [
          "application/json"
        ],
        "operationId": "deleteProject",
        "parameters": [
          {
            "description": "identifier of the project",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.ProjectResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "deletes a project and returns the deleted entity",
        "tags": [
          "project"
        ]
      },
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findProject",
        "parameters": [
          {
            "description": "identifier of the project",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.ProjectResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get project by id",
        "tags": [
          "project"
        ]
      }
    },
    "/v1/size": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "listSizes",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.SizeResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all sizes",
        "tags": [
          "size"
        ]
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "updateSize",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.SizeUpdateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.SizeResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "updates a size. if the size was changed since this one was read, a conflict is returned",
        "tags": [
          "size"
        ]
      },
      "put": {
        "consumes": [
          "application/json"
        ],
        "operationId": "createSize",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.SizeCreateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/v1.SizeResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "create a size. if the given ID already exists a conflict is returned",
        "tags": [
          "size"
        ]
      }
    },
    "/v1/size-image-constraint": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "listSizeImageConstraints",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.SizeImageConstraintResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all sizeimageconstraints",
        "tags": [
          "sizeimageconstraint"
        ]
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "updateSizeImageConstraint",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.SizeImageConstraintUpdateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.SizeImageConstraintResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "updates a sizeimageconstraint. if the sizeimageconstraint was changed since this one was read, a conflict is returned",
        "tags": [
          "sizeimageconstraint"
        ]
      },
      "put": {
        "consumes": [
          "application/json"
        ],
        "operationId": "createSizeImageConstraint",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.SizeImageConstraintCreateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/v1.SizeImageConstraintResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "create a sizeimageconstraint. if the given ID already exists a conflict is returned",
        "tags": [
          "sizeimageconstraint"
        ]
      }
    },
    "/v1/size-image-constraint/try": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "trySizeImageConstraint",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.SizeImageConstraintTryRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.EmptyBody"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "try if the given combination of image and size is supported and possible to allocate",
        "tags": [
          "sizeimageconstraint"
        ]
      }
    },
    "/v1/size-image-constraint/{id}": {
      "delete": {
        "consumes": [
          "application/json"
        ],
        "operationId": "deleteSizeImageConstraint",
        "parameters": [
          {
            "description": "identifier of the size",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.SizeImageConstraintResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "deletes an sizeimageconstraint and returns the deleted entity",
        "tags": [
          "sizeimageconstraint"
        ]
      },
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findSizeImageConstraint",
        "parameters": [
          {
            "description": "identifier of the sizeimageconstraint",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.SizeImageConstraintResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get sizeimageconstraint by id",
        "tags": [
          "sizeimageconstraint"
        ]
      }
    },
    "/v1/size/reservations": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "listSizeReservations",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.SizeReservationResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all size reservations",
        "tags": [
          "size"
        ]
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "updateSizeReservation",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.SizeReservationUpdateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.SizeReservationResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "updates a size reservation. if the size reservation was changed since this one was read, a conflict is returned",
        "tags": [
          "size"
        ]
      },
      "put": {
        "consumes": [
          "application/json"
        ],
        "operationId": "createSizeReservation",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.SizeReservationCreateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/v1.SizeReservationResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "create a size reservation. if the given ID already exists a conflict is returned",
        "tags": [
          "size"
        ]
      }
    },
    "/v1/size/reservations/find": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findSizeReservations",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.SizeReservationListRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.SizeReservationResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all size reservations",
        "tags": [
          "size"
        ]
      }
    },
    "/v1/size/reservations/usage": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "sizeReservationsUsage",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.SizeReservationListRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.SizeReservationUsageResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all size reservations",
        "tags": [
          "size"
        ]
      }
    },
    "/v1/size/reservations/{id}": {
      "delete": {
        "consumes": [
          "application/json"
        ],
        "operationId": "deleteSizeReservation",
        "parameters": [
          {
            "description": "identifier of the size reservation",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.SizeReservationResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "deletes a size reservation and returns the deleted entity",
        "tags": [
          "size"
        ]
      },
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "getSizeReservation",
        "parameters": [
          {
            "description": "identifier of the size reservation",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.SizeReservationResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get size reservation by id",
        "tags": [
          "size"
        ]
      }
    },
    "/v1/size/suggest": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "suggest",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.SizeSuggestRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.SizeConstraint"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "from a given machine id returns the appropriate size",
        "tags": [
          "size"
        ]
      }
    },
    "/v1/size/{id}": {
      "delete": {
        "consumes": [
          "application/json"
        ],
        "operationId": "deleteSize",
        "parameters": [
          {
            "description": "identifier of the size",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.SizeResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "deletes an size and returns the deleted entity",
        "tags": [
          "size"
        ]
      },
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findSize",
        "parameters": [
          {
            "description": "identifier of the size",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.SizeResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get size by id",
        "tags": [
          "size"
        ]
      }
    },
    "/v1/switch": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "listSwitches",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.SwitchResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all switches",
        "tags": [
          "switch"
        ]
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "updateSwitch",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.SwitchUpdateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.SwitchResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "updates a switch. if the switch was changed since this one was read, a conflict is returned",
        "tags": [
          "switch"
        ]
      }
    },
    "/v1/switch/find": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findSwitches",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.SwitchFindRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.SwitchResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all switches that match given properties",
        "tags": [
          "switch"
        ]
      }
    },
    "/v1/switch/register": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "registerSwitch",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.SwitchRegisterRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.SwitchResponse"
            }
          },
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/v1.SwitchResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "register a switch",
        "tags": [
          "switch"
        ]
      }
    },
    "/v1/switch/{id}": {
      "delete": {
        "consumes": [
          "application/json"
        ],
        "operationId": "deleteSwitch",
        "parameters": [
          {
            "description": "identifier of the switch",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "default": false,
            "description": "if true switch is deleted with no validation",
            "in": "query",
            "name": "force",
            "type": "boolean"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.SwitchResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "deletes an switch and returns the deleted entity",
        "tags": [
          "switch"
        ]
      },
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findSwitch",
        "parameters": [
          {
            "description": "identifier of the switch",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.SwitchResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get switch by id",
        "tags": [
          "switch"
        ]
      }
    },
    "/v1/switch/{id}/notify": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "notifySwitch",
        "parameters": [
          {
            "description": "identifier of the switch",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.SwitchNotifyRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.SwitchNotifyResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "notify the metal-api about a configuration change of a switch",
        "tags": [
          "switch"
        ]
      }
    },
    "/v1/switch/{id}/port": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "toggleSwitchPort",
        "parameters": [
          {
            "description": "identifier of the switch",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.SwitchPortToggleRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.SwitchResponse"
            }
          },
          "400": {
            "description": "Bad input data",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "toggles the port of the switch with a nicname to the given state",
        "tags": [
          "switch"
        ]
      }
    },
    "/v1/tenant": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "listTenants",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.TenantResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all tenants",
        "tags": [
          "tenant"
        ]
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "updateTenant",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.TenantUpdateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Updated",
            "schema": {
              "$ref": "#/definitions/v1.TenantResponse"
            }
          },
          "412": {
            "description": "OptimisticLock",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "update a tenant. optimistic lock error can occur.",
        "tags": [
          "tenant"
        ]
      },
      "put": {
        "consumes": [
          "application/json"
        ],
        "operationId": "createTenant",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.TenantCreateRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/v1.TenantResponse"
            }
          },
          "409": {
            "description": "Conflict",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "create a tenant. if the given ID already exists a conflict is returned",
        "tags": [
          "tenant"
        ]
      }
    },
    "/v1/tenant/find": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "findTenants",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.TenantFindRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/v1.TenantResponse"
              },
              "type": "array"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get all tenants that match given properties",
        "tags": [
          "tenant"
        ]
      }
    },
    "/v1/tenant/{id}": {
      "delete": {
        "consumes": [
          "application/json"
        ],
        "operationId": "deleteTenant",
        "parameters": [
          {
            "description": "identifier of the tenant",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.TenantResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "deletes a tenant and returns the deleted entity",
        "tags": [
          "tenant"
        ]
      },
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "getTenant",
        "parameters": [
          {
            "description": "identifier of the tenant",
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.TenantResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "get tenant by id",
        "tags": [
          "tenant"
        ]
      }
    },
    "/v1/user/me": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "getMe",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.User"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "extract the connecting user from auth header",
        "tags": [
          "user"
        ]
      }
    },
    "/v1/version": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "operationId": "info",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/rest.version"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "returns the current version information of this module",
        "tags": [
          "version"
        ]
      }
    },
    "/v1/vpn/authkey": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "operationId": "getVPNAuthKey",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1.VPNRequest"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/v1.VPNResponse"
            }
          },
          "default": {
            "description": "Error",
            "schema": {
              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
            }
          }
        },
        "summary": "create auth key to connect to project's VPN",
        "tags": [
          "vpn"
        ]
      }
    }
  },
  "security": [
    {
      "HMAC": []
    },
    {
      "jwt": []
    }
  ],
  "securityDefinitions": {
    "HMAC": {
      "description": "Generate a 'Authorization: Metal xxxx' header where 'xxxx' is a HMAC generated by the request-date, the request-method and the body",
      "in": "header",
      "name": "Authorization",
      "type": "apiKey"
    },
    "jwt": {
      "description": "Add a 'Authorization: Bearer xxxx' header to the request where 'xxxx' is the OIDC token retrieved from the identity provider's authentication endpoint",
      "in": "header",
      "name": "Authorization",
      "type": "apiKey"
    }
  },
  "swagger": "2.0",
  "tags": [
    {
      "description": "Managing audit entities",
      "name": "audit"
    },
    {
      "description": "Managing image entities",
      "name": "image"
    },
    {
      "description": "Managing network entities",
      "name": "network"
    },
    {
      "description": "Managing ip entities",
      "name": "ip"
    },
    {
      "description": "Managing size entities",
      "name": "size"
    },
    {
      "description": "Managing machine entities",
      "name": "machine"
    },
    {
      "description": "Managing partition entities",
      "name": "partition"
    },
    {
      "description": "Managing project entities",
      "name": "project"
    },
    {
      "description": "Managing switch entities",
      "name": "switch"
    },
    {
      "description": "Managing user entities",
      "name": "user"
    }
  ]
}