{"openapi":"3.1.0","info":{"title":"Compatibility Data API","description":"Shared product facts and complete setup answers. Evaluation coverage, not physical certification. Stores retain their own catalogue and checkout.","version":"0.5.0"},"paths":{"/health":{"get":{"summary":"Health","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/coverage":{"get":{"summary":"Coverage","operationId":"coverage_v1_coverage_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/products":{"get":{"summary":"Products","operationId":"products_v1_products_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":120,"default":"","title":"Q"}},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"enum":["host","dock","adapter","cable","power_supply","monitor"],"type":"string"},{"type":"null"}],"title":"Kind"}},{"name":"manufacturer","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Manufacturer"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Product"},"title":"Response Products V1 Products Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/products/{product_id}":{"get":{"summary":"Product Record","operationId":"product_record_v1_products__product_id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string","title":"Product Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/resolve":{"get":{"summary":"Resolve","operationId":"resolve_v1_resolve_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":120,"title":"Q"}},{"name":"manufacturer","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Manufacturer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dock/overview":{"get":{"summary":"Overview","operationId":"overview_v1_dock_overview_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"host_id","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":100,"title":"Host Id"}},{"name":"dock_id","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":100,"title":"Dock Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DockOverview"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/compatibility":{"get":{"summary":"Compatibility","operationId":"compatibility_v1_compatibility_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"host_id","in":"query","required":true,"schema":{"type":"string","maxLength":100,"title":"Host Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/export":{"get":{"summary":"Export","operationId":"export_v1_export_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"format","in":"query","required":false,"schema":{"enum":["catalogue","relationships","direct_relationships"],"type":"string","default":"catalogue","title":"Format"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/check":{"post":{"summary":"Check","operationId":"check_v1_check_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetupRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Assessment"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/direct/compatibility":{"get":{"summary":"Direct Compatibility","operationId":"direct_compatibility_v1_direct_compatibility_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"host_id","in":"query","required":true,"schema":{"type":"string","maxLength":100,"title":"Host Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/direct/check":{"post":{"summary":"Direct Check","operationId":"direct_check_v1_direct_check_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectAssessment"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/plan":{"post":{"summary":"Plan","operationId":"plan_v1_plan_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetupRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Assessment"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/recommend":{"post":{"summary":"Recommend","operationId":"recommend_v1_recommend_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecommendRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Assessment"},"type":"array","title":"Response Recommend V1 Recommend Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}}},"components":{"schemas":{"Adapter":{"properties":{"from_connector":{"type":"string","enum":["hdmi","mini_hdmi","displayport","mini_displayport","dvi","vga","usb_c"],"title":"From Connector"},"to_connector":{"type":"string","enum":["hdmi","mini_hdmi","displayport","mini_displayport","dvi","vga","usb_c"],"title":"To Connector"},"modes":{"items":{"type":"string","enum":["1080p60","1440p60","4k30","4k60","1920x1200_60","1680x1050_60","1600x900_60","1440x900_60","1280x1024_60"]},"type":"array","minItems":1,"title":"Modes"},"active":{"type":"boolean","title":"Active"},"separate_display_cable":{"type":"boolean","title":"Separate Display Cable"},"auxiliary_usb_power":{"type":"boolean","title":"Auxiliary Usb Power"},"direction_note":{"type":"string","title":"Direction Note"}},"additionalProperties":false,"type":"object","required":["from_connector","to_connector","modes","active","separate_display_cable","auxiliary_usb_power","direction_note"],"title":"Adapter"},"Assessment":{"properties":{"schema_version":{"type":"string","const":"0.5.0","title":"Schema Version","default":"0.5.0"},"rule_version":{"type":"string","title":"Rule Version","default":"0.4.1"},"data_version":{"type":"string","title":"Data Version"},"data_sha256":{"type":"string","title":"Data Sha256"},"release_status":{"type":"string","enum":["evaluation","commercial"],"title":"Release Status"},"host_id":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Host Id"},"dock_id":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Dock Id"},"status":{"type":"string","enum":["supported","conditional","unsupported","unknown","not_requested"],"title":"Status"},"summary":{"type":"string","title":"Summary"},"display":{"$ref":"#/components/schemas/Finding"},"power":{"$ref":"#/components/schemas/Finding"},"restrictions":{"items":{"$ref":"#/components/schemas/Finding"},"type":"array","title":"Restrictions"},"connection":{"$ref":"#/components/schemas/Finding"},"plan":{"$ref":"#/components/schemas/Plan"},"sources":{"items":{"$ref":"#/components/schemas/Source"},"type":"array","title":"Sources"},"basis":{"type":"string","title":"Basis","default":"Documented capabilities and explicit conditions, not physical testing of this combination."},"monitor_assumption":{"type":"string","title":"Monitor Assumption","default":"The selected monitor must itself support the requested mode on the stated input."},"environment_assumption":{"type":"string","title":"Environment Assumption","default":"Windows means Windows 10/11; macOS assumes a vendor-supported release. Required drivers and firmware must be installed. OS-release and firmware-specific troubleshooting is outside this assessment."}},"additionalProperties":false,"type":"object","required":["data_version","data_sha256","release_status","host_id","dock_id","status","summary","display","power","restrictions","connection","plan","sources"],"title":"Assessment"},"Attribute":{"properties":{"name":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Name"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"},{"type":"null"}],"title":"Value"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"qualification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Qualification"},"source_ids":{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","maxItems":30,"minItems":1,"title":"Source Ids"}},"additionalProperties":false,"type":"object","required":["name","value","source_ids"],"title":"Attribute"},"Cable":{"properties":{"cable_class":{"type":"string","enum":["thunderbolt_40gbps","usb_c_video","hdmi","displayport","mixed_display"],"title":"Cable Class"},"modes":{"items":{"type":"string","enum":["1080p60","1440p60","4k30","4k60","1920x1200_60","1680x1050_60","1600x900_60","1440x900_60","1280x1024_60"]},"type":"array","title":"Modes"},"power_ceiling_w":{"anyOf":[{"type":"integer","maximum":240,"minimum":0},{"type":"null"}],"title":"Power Ceiling W"},"from_connector":{"anyOf":[{"type":"string","enum":["hdmi","mini_hdmi","displayport","mini_displayport","dvi","vga","usb_c"]},{"type":"null"}],"title":"From Connector"},"to_connector":{"anyOf":[{"type":"string","enum":["hdmi","mini_hdmi","displayport","mini_displayport","dvi","vga","usb_c"]},{"type":"null"}],"title":"To Connector"}},"additionalProperties":false,"type":"object","required":["cable_class"],"title":"Cable"},"Connection":{"properties":{"monitor_index":{"type":"integer","title":"Monitor Index"},"output_group":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Output Group"},"dock_output":{"type":"string","enum":["hdmi","mini_hdmi","displayport","mini_displayport","dvi","vga","usb_c"],"title":"Dock Output"},"monitor_input":{"type":"string","enum":["hdmi","mini_hdmi","displayport","mini_displayport","dvi","vga","usb_c"],"title":"Monitor Input"},"mode":{"type":"string","enum":["1080p60","1440p60","4k30","4k60","1920x1200_60","1680x1050_60","1600x900_60","1440x900_60","1280x1024_60"],"title":"Mode"},"adapter_id":{"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},{"type":"null"}],"title":"Adapter Id"},"cable_id":{"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},{"type":"null"}],"title":"Cable Id"},"description":{"type":"string","title":"Description"}},"additionalProperties":false,"type":"object","required":["monitor_index","output_group","dock_output","monitor_input","mode","description"],"title":"Connection"},"DirectAssessment":{"properties":{"schema_version":{"type":"string","const":"0.5.0","title":"Schema Version","default":"0.5.0"},"rule_version":{"type":"string","title":"Rule Version","default":"0.4.1"},"data_version":{"type":"string","title":"Data Version"},"data_sha256":{"type":"string","title":"Data Sha256"},"release_status":{"type":"string","enum":["evaluation","commercial"],"title":"Release Status"},"host_id":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Host Id"},"monitor_id":{"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},{"type":"null"}],"title":"Monitor Id"},"power_supply_id":{"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},{"type":"null"}],"title":"Power Supply Id"},"status":{"type":"string","enum":["supported","conditional","unsupported","unknown","not_requested"],"title":"Status"},"display":{"$ref":"#/components/schemas/DirectFinding"},"connection":{"$ref":"#/components/schemas/DirectFinding"},"power":{"$ref":"#/components/schemas/DirectFinding"},"paths":{"items":{"$ref":"#/components/schemas/DirectPath"},"type":"array","title":"Paths"},"sources":{"items":{"$ref":"#/components/schemas/Source"},"type":"array","title":"Sources"},"scope":{"type":"string","title":"Scope","default":"One directly connected external monitor and/or a replacement laptop charger. No dock, daisy chain or multi-monitor conclusion. Product choices do not imply ownership, stock or included cables. Monitor mains power is separate. Documented compatibility, not physical testing; supported drivers and firmware are assumed."}},"additionalProperties":false,"type":"object","required":["data_version","data_sha256","release_status","host_id","monitor_id","power_supply_id","status","display","connection","power","paths","sources"],"title":"DirectAssessment"},"DirectFinding":{"properties":{"status":{"type":"string","enum":["supported","conditional","unsupported","unknown","not_requested"],"title":"Status"},"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Code"},"explanation":{"type":"string","title":"Explanation"},"source_ids":{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","title":"Source Ids"},"rule_ids":{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","title":"Rule Ids"},"conditions":{"items":{"type":"string"},"type":"array","title":"Conditions"},"missing":{"items":{"type":"string"},"type":"array","title":"Missing"}},"additionalProperties":false,"type":"object","required":["status","code","explanation"],"title":"DirectFinding"},"DirectPath":{"properties":{"host_port_id":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Host Port Id"},"host_output":{"type":"string","enum":["hdmi","mini_hdmi","displayport","mini_displayport","dvi","vga","usb_c"],"title":"Host Output"},"monitor_port_id":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Monitor Port Id"},"monitor_input":{"type":"string","enum":["hdmi","mini_hdmi","displayport","mini_displayport","dvi","vga","usb_c"],"title":"Monitor Input"},"mode":{"type":"string","enum":["1080p60","1440p60","4k30","4k60","1920x1200_60","1680x1050_60","1600x900_60","1440x900_60","1280x1024_60"],"title":"Mode"},"cable_requirement":{"type":"string","title":"Cable Requirement"},"compatible_cable_ids":{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","title":"Compatible Cable Ids"},"selected_cable_id":{"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},{"type":"null"}],"title":"Selected Cable Id"},"source_ids":{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","title":"Source Ids"},"rule_ids":{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","title":"Rule Ids"}},"additionalProperties":false,"type":"object","required":["host_port_id","host_output","monitor_port_id","monitor_input","mode","cable_requirement","source_ids","rule_ids"],"title":"DirectPath"},"DirectRequest":{"properties":{"host_id":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Host Id"},"operating_system":{"anyOf":[{"type":"string","enum":["windows","macos","linux","chromeos"]},{"type":"null"}],"title":"Operating System"},"monitor_id":{"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},{"type":"null"}],"title":"Monitor Id"},"mode":{"anyOf":[{"type":"string","enum":["1080p60","1440p60","4k30","4k60","1920x1200_60","1680x1050_60","1600x900_60","1440x900_60","1280x1024_60"]},{"type":"null"}],"title":"Mode"},"host_port_id":{"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},{"type":"null"}],"title":"Host Port Id"},"monitor_input":{"anyOf":[{"type":"string","enum":["hdmi","mini_hdmi","displayport","mini_displayport","dvi","vga","usb_c"]},{"type":"null"}],"title":"Monitor Input"},"cable_id":{"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},{"type":"null"}],"title":"Cable Id"},"power_supply_id":{"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},{"type":"null"}],"title":"Power Supply Id"}},"additionalProperties":false,"type":"object","required":["host_id"],"title":"DirectRequest"},"Dock":{"properties":{"technology":{"type":"string","enum":["native","displaylink"],"title":"Technology"},"output_groups":{"items":{"$ref":"#/components/schemas/OutputGroup"},"type":"array","maxItems":4,"minItems":1,"title":"Output Groups"},"max_external_screens":{"type":"integer","maximum":4,"minimum":1,"title":"Max External Screens"},"native_mac_mirroring":{"type":"boolean","title":"Native Mac Mirroring","default":false},"host_cable_requirement":{"type":"string","enum":["thunderbolt_40gbps","usb_c_video","usb_data","attached"],"title":"Host Cable Requirement"},"host_connectors":{"items":{"type":"string","enum":["usb_c","usb_a"]},"type":"array","minItems":1,"title":"Host Connectors","default":["usb_c"]},"charge_requires_original_host_cable":{"type":"boolean","title":"Charge Requires Original Host Cable","default":false},"power_required_for_operation":{"type":"boolean","title":"Power Required For Operation"},"power_supply_description":{"type":"string","title":"Power Supply Description"},"power_supply_candidates":{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","title":"Power Supply Candidates"},"displaylink_source_ids":{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","title":"Displaylink Source Ids"},"host_cable_candidates":{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","title":"Host Cable Candidates"},"additional_prerequisites":{"items":{"type":"string"},"type":"array","title":"Additional Prerequisites"},"power_button_support":{"type":"string","enum":["not_documented","same_brand_only"],"title":"Power Button Support","default":"not_documented"},"power_button_source_ids":{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","title":"Power Button Source Ids"}},"additionalProperties":false,"type":"object","required":["technology","output_groups","max_external_screens","host_cable_requirement","power_required_for_operation","power_supply_description"],"title":"Dock"},"DockDisplayOption":{"properties":{"request":{"$ref":"#/components/schemas/SetupRequest"},"assessment":{"$ref":"#/components/schemas/Assessment"}},"additionalProperties":false,"type":"object","required":["request","assessment"],"title":"DockDisplayOption"},"DockOverview":{"properties":{"overview_version":{"type":"integer","const":1,"title":"Overview Version","default":1},"schema_version":{"type":"string","const":"0.5.0","title":"Schema Version","default":"0.5.0"},"rule_version":{"type":"string","title":"Rule Version","default":"0.4.1"},"data_version":{"type":"string","title":"Data Version"},"data_sha256":{"type":"string","title":"Data Sha256"},"release_status":{"type":"string","enum":["evaluation","commercial"],"title":"Release Status"},"host_id":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Host Id"},"dock_id":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Dock Id"},"operating_system":{"type":"string","enum":["windows","macos","linux","chromeos"],"title":"Operating System"},"host_connectors":{"items":{"type":"string","enum":["usb_c","usb_a"]},"type":"array","title":"Host Connectors"},"connection":{"$ref":"#/components/schemas/Finding"},"display_options":{"items":{"$ref":"#/components/schemas/DockDisplayOption"},"type":"array","title":"Display Options"},"power_options":{"items":{"$ref":"#/components/schemas/DockPowerOption"},"type":"array","title":"Power Options"},"requirements":{"items":{"$ref":"#/components/schemas/Finding"},"type":"array","title":"Requirements"},"sources":{"items":{"$ref":"#/components/schemas/Source"},"type":"array","title":"Sources"},"scope":{"type":"string","title":"Scope","default":"Documented connection, display and charging information for these products. Screen configurations are options, not customer requirements. USB peripheral, Ethernet, audio and dock power-button behaviour are not confirmed here. No screen models or included parts are assumed."}},"additionalProperties":false,"type":"object","required":["data_version","data_sha256","release_status","host_id","dock_id","operating_system","host_connectors","connection","display_options","power_options","requirements","sources"],"title":"DockOverview"},"DockPowerOption":{"properties":{"host_connector":{"type":"string","enum":["usb_c","usb_a"],"title":"Host Connector"},"supply":{"$ref":"#/components/schemas/SupplySelection"},"host_cable":{"type":"string","const":"original","title":"Host Cable","default":"original"},"finding":{"$ref":"#/components/schemas/Finding"}},"additionalProperties":false,"type":"object","required":["host_connector","supply","finding"],"title":"DockPowerOption"},"Finding":{"properties":{"status":{"type":"string","enum":["supported","conditional","unsupported","unknown","not_requested"],"title":"Status"},"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Code"},"explanation":{"type":"string","title":"Explanation"},"source_ids":{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","title":"Source Ids"},"rule_ids":{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","title":"Rule Ids"},"missing":{"items":{"type":"string"},"type":"array","title":"Missing"},"conditions":{"items":{"type":"string"},"type":"array","title":"Conditions"},"dock_delivery_ceiling_w":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Dock Delivery Ceiling W"}},"additionalProperties":false,"type":"object","required":["status","code","explanation"],"title":"Finding"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Host":{"properties":{"video_classes":{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","maxItems":10,"minItems":1,"title":"Video Classes"},"native_external_limit":{"anyOf":[{"type":"integer","maximum":8,"minimum":0},{"type":"null"}],"title":"Native External Limit"},"usb_c_charging":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Usb C Charging"},"default_os":{"type":"string","enum":["windows","macos","linux","chromeos"],"title":"Default Os"},"port_note":{"type":"string","title":"Port Note"}},"additionalProperties":false,"type":"object","required":["video_classes","default_os","port_note"],"title":"Host"},"Monitor":{"properties":{"preferred_mode":{"type":"string","enum":["1080p60","1440p60","4k30","4k60","1920x1200_60","1680x1050_60","1600x900_60","1440x900_60","1280x1024_60"],"title":"Preferred Mode"},"inputs":{"items":{"$ref":"#/components/schemas/MonitorPort"},"type":"array","minItems":1,"title":"Inputs"}},"additionalProperties":false,"type":"object","required":["preferred_mode","inputs"],"title":"Monitor"},"MonitorNeed":{"properties":{"input":{"type":"string","enum":["hdmi","mini_hdmi","displayport","mini_displayport","dvi","vga","usb_c"],"title":"Input"},"mode":{"type":"string","enum":["1080p60","1440p60","4k30","4k60","1920x1200_60","1680x1050_60","1600x900_60","1440x900_60","1280x1024_60"],"title":"Mode"}},"additionalProperties":false,"type":"object","required":["input","mode"],"title":"MonitorNeed"},"MonitorPort":{"properties":{"port_id":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Port Id"},"connector":{"type":"string","enum":["hdmi","mini_hdmi","displayport","mini_displayport","dvi","vga","usb_c"],"title":"Connector"},"modes":{"items":{"type":"string","enum":["1080p60","1440p60","4k30","4k60","1920x1200_60","1680x1050_60","1600x900_60","1440x900_60","1280x1024_60"]},"type":"array","minItems":1,"title":"Modes"},"unsupported_modes":{"items":{"type":"string","enum":["1080p60","1440p60","4k30","4k60","1920x1200_60","1680x1050_60","1600x900_60","1440x900_60","1280x1024_60"]},"type":"array","title":"Unsupported Modes"},"source_ids":{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","maxItems":30,"minItems":1,"title":"Source Ids"}},"additionalProperties":false,"type":"object","required":["port_id","connector","modes","source_ids"],"title":"MonitorPort"},"OutputGroup":{"properties":{"id":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Id"},"connectors":{"items":{"type":"string","enum":["hdmi","mini_hdmi","displayport","mini_displayport","dvi","vga","usb_c"]},"type":"array","maxItems":4,"minItems":1,"title":"Connectors"},"modes":{"anyOf":[{"items":{"type":"string","enum":["1080p60","1440p60","4k30","4k60","1920x1200_60","1680x1050_60","1600x900_60","1440x900_60","1280x1024_60"]},"type":"array"},{"type":"null"}],"title":"Modes"}},"additionalProperties":false,"type":"object","required":["id","connectors"],"title":"OutputGroup"},"OwnedPart":{"properties":{"requirement_id":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Requirement Id"},"quantity":{"type":"integer","maximum":20,"minimum":1,"title":"Quantity"}},"additionalProperties":false,"type":"object","required":["requirement_id","quantity"],"title":"OwnedPart"},"PartRequirement":{"properties":{"id":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Id"},"kind":{"type":"string","enum":["dock","host_cable","display_cable","adapter","power_supply","auxiliary_power"],"title":"Kind"},"description":{"type":"string","title":"Description"},"quantity":{"type":"integer","title":"Quantity"},"quantity_owned":{"type":"integer","title":"Quantity Owned","default":0},"included_in_selected_product":{"type":"boolean","title":"Included In Selected Product","default":false},"quantity_to_obtain":{"type":"integer","title":"Quantity To Obtain"},"compatible_product_ids":{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","title":"Compatible Product Ids"},"source_ids":{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","title":"Source Ids"}},"additionalProperties":false,"type":"object","required":["id","kind","description","quantity","quantity_to_obtain"],"title":"PartRequirement"},"Plan":{"properties":{"status":{"type":"string","enum":["supported","conditional","unsupported","unknown","not_requested"],"title":"Status"},"completeness":{"type":"string","enum":["requirements_only","all_requirements_have_candidates","unresolved"],"title":"Completeness"},"connections":{"items":{"$ref":"#/components/schemas/Connection"},"type":"array","title":"Connections"},"parts":{"items":{"$ref":"#/components/schemas/PartRequirement"},"type":"array","title":"Parts"},"missing":{"items":{"type":"string"},"type":"array","title":"Missing"},"note":{"type":"string","title":"Note","default":"Candidate IDs are alternatives, not stock or bundle claims. The store selects its own products."}},"additionalProperties":false,"type":"object","required":["status","completeness"],"title":"Plan"},"Port":{"properties":{"id":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Id"},"connector":{"type":"string","enum":["hdmi","mini_hdmi","displayport","mini_displayport","dvi","vga","usb_c","usb_a","dc_barrel","lenovo_slim_tip","surface_connect"],"title":"Connector"},"role":{"type":"string","enum":["host","display_output","display_input","data","power_input"],"title":"Role"},"count":{"type":"integer","maximum":20,"minimum":1,"title":"Count","default":1},"features":{"items":{"type":"string"},"type":"array","title":"Features"},"source_ids":{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","maxItems":30,"minItems":1,"title":"Source Ids"}},"additionalProperties":false,"type":"object","required":["id","connector","role","source_ids"],"title":"Port"},"Product":{"properties":{"id":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Id"},"kind":{"type":"string","enum":["host","dock","adapter","cable","power_supply","monitor"],"title":"Kind"},"manufacturer":{"type":"string","title":"Manufacturer"},"model":{"type":"string","title":"Model"},"manufacturer_part_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer Part Number"},"identity_scope":{"type":"string","enum":["family","part"],"title":"Identity Scope"},"aliases":{"items":{"type":"string"},"type":"array","title":"Aliases"},"ports":{"items":{"$ref":"#/components/schemas/Port"},"type":"array","title":"Ports"},"attributes":{"items":{"$ref":"#/components/schemas/Attribute"},"type":"array","title":"Attributes"},"notes":{"items":{"type":"string"},"type":"array","title":"Notes"},"source_ids":{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","maxItems":30,"minItems":1,"title":"Source Ids"},"host":{"anyOf":[{"$ref":"#/components/schemas/Host"},{"type":"null"}]},"dock":{"anyOf":[{"$ref":"#/components/schemas/Dock"},{"type":"null"}]},"adapter":{"anyOf":[{"$ref":"#/components/schemas/Adapter"},{"type":"null"}]},"cable":{"anyOf":[{"$ref":"#/components/schemas/Cable"},{"type":"null"}]},"power_supply":{"anyOf":[{"$ref":"#/components/schemas/Supply"},{"type":"null"}]},"monitor":{"anyOf":[{"$ref":"#/components/schemas/Monitor"},{"type":"null"}]}},"additionalProperties":false,"type":"object","required":["id","kind","manufacturer","model","identity_scope","source_ids"],"title":"Product"},"RecommendRequest":{"properties":{"host_id":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Host Id"},"operating_system":{"type":"string","enum":["windows","macos","linux","chromeos"],"title":"Operating System"},"host_connector":{"type":"string","enum":["usb_c","usb_a"],"title":"Host Connector","default":"usb_c"},"monitors":{"items":{"$ref":"#/components/schemas/MonitorNeed"},"type":"array","maxItems":3,"minItems":1,"title":"Monitors"},"software_allowed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Software Allowed"},"use":{"type":"string","enum":["office","protected_video","gaming"],"title":"Use","default":"office"},"charge":{"type":"boolean","title":"Charge","default":false},"required_power_w":{"anyOf":[{"type":"integer","maximum":240,"minimum":1},{"type":"null"}],"title":"Required Power W"},"supply":{"$ref":"#/components/schemas/SupplySelection"},"host_cable":{"type":"string","enum":["unknown","original","thunderbolt_40gbps","usb_c_video","usb_data_only"],"title":"Host Cable","default":"unknown"},"require_dock_power_button":{"type":"boolean","title":"Require Dock Power Button","default":false},"candidate_ids":{"anyOf":[{"items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},"type":"array","maxItems":50,"minItems":1},{"type":"null"}],"title":"Candidate Ids"}},"additionalProperties":false,"type":"object","required":["host_id","operating_system","monitors"],"title":"RecommendRequest"},"SetupRequest":{"properties":{"host_id":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Host Id"},"operating_system":{"type":"string","enum":["windows","macos","linux","chromeos"],"title":"Operating System"},"host_connector":{"type":"string","enum":["usb_c","usb_a"],"title":"Host Connector","default":"usb_c"},"monitors":{"items":{"$ref":"#/components/schemas/MonitorNeed"},"type":"array","maxItems":3,"minItems":1,"title":"Monitors"},"software_allowed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Software Allowed"},"use":{"type":"string","enum":["office","protected_video","gaming"],"title":"Use","default":"office"},"charge":{"type":"boolean","title":"Charge","default":false},"required_power_w":{"anyOf":[{"type":"integer","maximum":240,"minimum":1},{"type":"null"}],"title":"Required Power W"},"supply":{"$ref":"#/components/schemas/SupplySelection"},"host_cable":{"type":"string","enum":["unknown","original","thunderbolt_40gbps","usb_c_video","usb_data_only"],"title":"Host Cable","default":"unknown"},"require_dock_power_button":{"type":"boolean","title":"Require Dock Power Button","default":false},"dock_id":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Dock Id"},"owned_parts":{"items":{"$ref":"#/components/schemas/OwnedPart"},"type":"array","maxItems":30,"title":"Owned Parts"}},"additionalProperties":false,"type":"object","required":["host_id","operating_system","monitors","dock_id"],"title":"SetupRequest"},"Source":{"properties":{"id":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Id"},"title":{"type":"string","title":"Title"},"url":{"type":"string","pattern":"^https://[^\\s]+$","title":"Url"},"locator":{"type":"string","title":"Locator"},"checked_on":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","title":"Checked On"},"review_status":{"type":"string","enum":["reviewed","needs_review","withdrawn"],"title":"Review Status","default":"reviewed"},"review_after_days":{"type":"integer","maximum":730,"minimum":1,"title":"Review After Days","default":180},"permission":{"type":"string","enum":["evaluation_only","commercial_cleared"],"title":"Permission","default":"evaluation_only"},"permission_basis":{"type":"string","title":"Permission Basis"},"sha256":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{64}$"},{"type":"null"}],"title":"Sha256"}},"additionalProperties":false,"type":"object","required":["id","title","url","locator","checked_on","permission_basis"],"title":"Source"},"Supply":{"properties":{"supply_class":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$","title":"Supply Class"},"rated_output_w":{"type":"integer","maximum":500,"exclusiveMinimum":0,"title":"Rated Output W"},"connector":{"type":"string","enum":["hdmi","mini_hdmi","displayport","mini_displayport","dvi","vga","usb_c","usb_a","dc_barrel","lenovo_slim_tip","surface_connect"],"title":"Connector"}},"additionalProperties":false,"type":"object","required":["supply_class","rated_output_w","connector"],"title":"Supply"},"SupplySelection":{"properties":{"kind":{"type":"string","enum":["unknown","none","original","product"],"title":"Kind","default":"unknown"},"product_id":{"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,99}$"},{"type":"null"}],"title":"Product Id"}},"additionalProperties":false,"type":"object","title":"SupplySelection"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}}},"servers":[{"url":"/api"}]}