Skip to content
This repository has been archived by the owner on Jul 24, 2021. It is now read-only.

Commit

Permalink
Merge pull request #1069 from joyent/ether/hardware_product-specifica…
Browse files Browse the repository at this point in the history 
…tion-annotations

add hardware product specification annotations
  • Loading branch information
@karenetheridge
karenetheridge committed Nov 30, 2020
2 parents 452beea + 2cd7fed commit 9ee8a2c
Show file tree
Hide file tree
Showing 8 changed files with 396 additions and 20 deletions.
8 changes: 7 additions & 1 deletion docs/json-schema/common.json
View file
Expand Up @@ -2,8 +2,9 @@
"$comment" : "NOTE: This file is for human reference ONLY. For programmatic use, use the GET '/json_schema/common/$schema_name' endpoints, or within conch itself, json-schema/common.yaml.",
"$defs" : {
"HardwareProductSpecification" : {
"$comment" : "this is the structure of the hardware_product.specification database column",
"$comment" : "this is the structure of the hardware_product.specification database column. NOTE: by conch api v3.2 this schema will be in the json_schema table in the database (available via GET /json_schema/hardware_product/specification/latest) so it can be updated dynamically",
"additionalProperties" : true,
"deprecated" : true,
"properties" : {
"chassis" : {
"properties" : {
Expand All @@ -21,23 +22,28 @@
"type" : "object"
},
"minItems" : 1,
"title" : "DIMMs",
"type" : "array"
}
},
"title" : "Memory",
"type" : "object"
}
},
"title" : "Chassis",
"type" : "object"
},
"disk_size" : {
"$comment" : "property names correspond to device report /disks/<disk serial>/model",
"additionalProperties" : {
"$comment" : "property values are compared to device report /disks/<disk serial>/block_sz",
"title" : "Drive Model",
"type" : "integer"
},
"required" : [
"_default"
],
"title" : "Disk Size",
"type" : "object"
}
},
Expand Down
106 changes: 96 additions & 10 deletions docs/json-schema/request.json
View file
Expand Up @@ -413,27 +413,45 @@
"minProperties" : 1,
"properties" : {
"alias" : {
"$ref" : "common.json#/$defs/mojo_standard_placeholder"
"$ref" : "common.json#/$defs/mojo_standard_placeholder",
"title" : "Alias"
},
"bios_firmware" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "BIOS Firmware",
"type" : "string"
},
"cpu_num" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "Number of CPUs",
"type" : "integer"
},
"cpu_type" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "CPU Type",
"type" : "string"
},
"dimms_num" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "Number of DIMMs",
"type" : "integer"
},
"generation_name" : {
"$ref" : "common.json#/$defs/non_empty_string"
"$ref" : "common.json#/$defs/non_empty_string",
"title" : "Generation Name"
},
"hardware_vendor_id" : {
"$ref" : "common.json#/$defs/uuid"
"$ref" : "common.json#/$defs/uuid",
"title" : "Hardware Vendor ID"
},
"hba_firmware" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "HBA Firmware",
"type" : [
"null",
"string"
Expand All @@ -447,24 +465,38 @@
{
"type" : "null"
}
]
],
"title" : "Legacy Product Name"
},
"name" : {
"$ref" : "common.json#/$defs/mojo_standard_placeholder"
"$ref" : "common.json#/$defs/mojo_standard_placeholder",
"title" : "Name"
},
"nics_num" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "Number of NICs",
"type" : "integer"
},
"nvme_ssd_num" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "Number of SAS HDDs",
"type" : "integer"
},
"nvme_ssd_size" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "NVME SSD Size",
"type" : [
"null",
"integer"
]
},
"nvme_ssd_slots" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "NVME SSD Slots",
"type" : [
"null",
"string"
Expand All @@ -478,85 +510,134 @@
{
"type" : "null"
}
]
],
"title" : "Prefix"
},
"psu_total" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "PSU Total",
"type" : "integer"
},
"purpose" : {
"title" : "Purpose",
"type" : "string"
},
"rack_unit_size" : {
"$ref" : "common.json#/$defs/positive_integer"
"$ref" : "common.json#/$defs/positive_integer",
"title" : "Rack Unit Size (RU)"
},
"raid_lun_num" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "Number of RAID LUNs",
"type" : "integer"
},
"ram_total" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "RAM Total",
"type" : "integer"
},
"sas_hdd_num" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "Number of SAS HDDs",
"type" : "integer"
},
"sas_hdd_size" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "SAS HDD Size",
"type" : [
"null",
"integer"
]
},
"sas_hdd_slots" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "SAS HDD Slots",
"type" : [
"null",
"string"
]
},
"sas_ssd_num" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "Number of SSD SSDs",
"type" : "integer"
},
"sas_ssd_size" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "SAS SSD Size",
"type" : [
"null",
"integer"
]
},
"sas_ssd_slots" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "SAS SSD Slots",
"type" : [
"null",
"string"
]
},
"sata_hdd_num" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "Number of SATA HDDs",
"type" : "integer"
},
"sata_hdd_size" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "SATA HDD Size",
"type" : [
"null",
"integer"
]
},
"sata_hdd_slots" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "SATA HDD Slots",
"type" : [
"null",
"string"
]
},
"sata_ssd_num" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "Number of SATA SSDs",
"type" : "integer"
},
"sata_ssd_size" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "SATA SSD Size",
"type" : [
"null",
"integer"
]
},
"sata_ssd_slots" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "SATA SSD Slots",
"type" : [
"null",
"string"
]
},
"sku" : {
"$ref" : "common.json#/$defs/mojo_standard_placeholder"
"$ref" : "common.json#/$defs/mojo_standard_placeholder",
"title" : "SKU"
},
"specification" : {
"oneOf" : [
Expand All @@ -566,15 +647,20 @@
{
"type" : "null"
}
]
],
"title" : "Specification"
},
"usb_num" : {
"$comment" : "this property will be moved into /specification in v3.2",
"deprecated" : true,
"title" : "Number of USBs",
"type" : "integer"
},
"validation_plan_id" : {
"$comment" : "this property will become nullable in v3.3 and removed in v4.0",
"$ref" : "common.json#/$defs/uuid",
"deprecated" : true
"deprecated" : true,
"title" : "Validation Plan ID"
}
},
"type" : "object"
Expand Down

0 comments on commit 9ee8a2c

Please sign in to comment.