{ "format": 1, "severities": [ "error", "warning", "at-verified", "mixed", "mixed-at-verified" ], "rules": [ { "code": "L0", "scope": "any yaml", "rule": "the file parses as YAML", "why": "A file that does not parse cannot be drawn, exported or checked at all, so the fault is reported at its own line rather than as an unexplained failure further on.", "fix": "fix the syntax the message points at; a `#` after a space inside an unquoted string starts a comment", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L1", "scope": "any yaml", "rule": "the file validates against its schema", "why": "The renderer, the exports and every later check read the shape the schema describes, so a misspelt key or a value of the wrong type would otherwise be ignored or misread without a word.", "fix": "the path in the message names the key; the schema's description for it says what is accepted", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L2", "scope": "any id", "rule": "every id and segment matches ^[a-z0-9]+(-[a-z0-9]+)*$ with no double hyphen", "why": "Every id becomes a segment of the element ids and data paths in each drawing, so a capital, a space or a double hyphen would break the addresses that selectors, the explorer tree and the exports rely on.", "fix": "rename the id; it becomes a DOM id segment in every SVG", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L3", "scope": "component", "rule": "every contracted element id exists in every declared skin", "why": "A skin without an element the contract promises draws that variant without the node the explorer, the lamp states and the 3D relief address, so the element silently vanishes when that skin is chosen.", "fix": "add the element to the skin, or remove it from `elements:`", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L4", "scope": "component", "rule": "each skin's viewBox matches the contract size", "why": "A skin drawn to a different size from its contract is stretched or shifted when it is placed in millimetres, so every opening and lamp in it lands in the wrong place on the faceplate.", "fix": "set `viewBox=\"0 0 \"` and mm width/height from `size`", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L5", "scope": "device", "rule": "placement refs resolve in the library, and instance ids are unique per view; no placement ref, and no bay's `accepts` or `default`, is a `kind: kit`, which a device names only from `chassis.kits`", "why": "A placement that resolves to nothing, or two parts sharing one id in a view, leave a missing part or an ambiguous address in the drawing, and a rail kit placed like a module draws something no build contains.", "fix": "fix the `ref` (namespace/name@major) or the duplicate id; list a rail kit under `chassis.kits` and place its parts, if anything, by their own refs", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L6", "scope": "device", "rule": "a bay's default appears in its accepts list", "why": "A bay whose default it does not accept draws a module the vendor says does not fit there, and a bay nothing ever fills draws as an empty frame in every drawing of the device.", "fix": "add the default to `accepts`, or change the default", "severity": "mixed", "fails": true, "warns": true, "fails-at-verified": false }, { "code": "L7", "scope": "device", "rule": "region members reference existing instance ids", "why": "A region framing an id that is not in its view frames nothing, so a reader sees a labelled block whose members the drawing cannot find.", "fix": "name ids that exist in the same view", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L8", "scope": "device", "rule": "a configuration seats only what its bays accept, and only in bays that exist in it", "why": "A configuration that seats a module its bay does not accept, or fills a bay its build does not have, shows a fit-out nobody can order, or silently drops the module.", "fix": "add the occupant to the bay's `accepts`, or seat something the bay takes; for a bay `only-in` scopes out, add the configuration to it or drop the key", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L9", "scope": "component", "rule": "a conforms-declared size matches spec/schemas/standards.yaml", "why": "A part that claims a published standard but is drawn to another size passes a wrong aperture to every device that places it, with the standard's name vouching for it.", "fix": "take the size from the registry, or drop `conforms` if the part is not the standard aperture", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L10", "scope": "component", "rule": "composed parts resolve, ids are unique, composition does not cycle (depth <= 4), and neither a part nor a bay's `default` or `accepts` is a `kind: kit`", "why": "A composition that names a missing part, repeats an id or loops back on itself cannot be drawn, and a kit composed as a part offers something no configuration can hold.", "fix": "fix the `parts:` refs; a part must not compose itself; a kit is named from a device's `chassis.kits`, never composed or seated", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L11", "scope": "component", "rule": "interface/mates declarations carry a `mate` connection point, and a wrapper keeps the interface of what it composes", "why": "A receptacle or plug with no mate point has nothing to align to, so it cannot be seated, and a wrapper that changes its interface lets parts pass the fit check against something they do not really mate.", "fix": "add `connection-points.mate`; do not change the interface in a wrapper", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L12", "scope": "device", "rule": "mate-to resolves to a receptacle whose interface the occupant mates; a seated part's `rate` is at or below its cage's media", "why": "A drawing could otherwise seat a part where it cannot go, such as a QSFP transceiver in an SFP cage or a 10G cable in a 1G cage, while still looking right.", "fix": "point `mate-to` at the receptacle id; check `interface` and `mates` agree; seat a part the cage offers", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L13", "scope": "device", "rule": "two placed components do not occupy the same faceplate area", "why": "Two parts on one patch of faceplate are almost always a sizing mistake, hidden in the flat drawing where one paints over the other and plain in 3D as a lamp hanging over a port.", "fix": "move one, or declare `for:`/`under:` when one deliberately sits on the other", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L14", "scope": "device", "rule": "a silkscreen `for:` target exists and is nearby", "why": "A legend or lamp bound to a part that does not exist, or to one across the panel, tells a reader and every tool that follows the binding something false about what it annotates.", "fix": "name the placement or bay the mark annotates, and anchor the mark at it", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L15", "scope": "device", "rule": "a device at `modelled` or above has a provenance block good enough for the level", "why": "A device that claims to be modelled or verified could otherwise carry figures with no source, so nobody could tell a measured dimension from a guess.", "fix": "add provenance for every figure, or lower `maturity`", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L16", "scope": "device", "rule": "keys inside a view read in manufacturing order", "why": "Anyone building a device follows the file stage by stage, so a view written out of manufacturing order teaches the wrong procedure and is harder to compare with its neighbours.", "fix": "reorder: empty, size, open-frame, panel, silkscreen, components, regions", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L17", "scope": "component, device", "rule": "a placement's or part's group is declared under `groups:`, and a component that declares groups puts every port part in one", "why": "A group used but never declared carries no vendor term, role or numbering origin, and on a card, ports half inside and half outside groups read as two kinds of port where there is one.", "fix": "declare the group with term, role and index-origin; join the loose port to a group", "severity": "mixed", "fails": true, "warns": true, "fails-at-verified": false }, { "code": "L18", "scope": "device", "rule": "a port inherits media from its group rather than restating it", "why": "A port that takes its media from a cage covering a whole family shows only the family, so an SFP28 port reads as SFP and the model looks complete when it is not.", "fix": "drop the per-port media, or fix the group's `attrs.media`", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L19", "scope": "device", "rule": "an indicator declares `for:` the thing it indicates - a lamp, button or display placement, and a bay in a group whose role is `indicator`", "why": "A lamp, button or display with no stated subject leaves its meaning to a naming convention a reader can guess and no tool can read.", "fix": "add `for:` to the lamp placement or the bay; a panel that reports on the whole box is `for: chassis`", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L20", "scope": "component, device", "rule": "state names are tokens and each `behavior` is well-formed, on a contract's states, an element's, or a placement's", "why": "A state written as prose cannot become the class and the chip the viewer builds from it, and a malformed behaviour cannot be animated, so the lamp's real meaning reaches no one.", "fix": "a state name is a token like `link`; prose goes in `description`; `behavior` is solid, blinking, alternating or sequence, with `behavior.color` for the second colour", "severity": "mixed", "fails": true, "warns": true, "fails-at-verified": false }, { "code": "L21", "scope": "device", "rule": "chassis silkscreen does not sit under a bay where the module covers it", "why": "A legend printed where a module sits is painted over by it and cannot be read in the drawing.", "fix": "move the mark, or put it in the module's own skin if the module carries it", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L22", "scope": "component, device", "rule": "a group's declared media/speed matches the ports it holds", "why": "A group's attributes are copied onto every member, so a group whose media or speed contradicts a member would quietly relabel that port, for example an RJ45 jack drawn as SFP28.", "fix": "fix the group's `attrs`, or move the odd port to its own group", "severity": "mixed", "fails": true, "warns": true, "fails-at-verified": false }, { "code": "L23", "scope": "component, device", "rule": "a port group is one family, or says in `mixed:` why it is not", "why": "A group mixing connector families cannot carry shared attributes, and an unexplained mix cannot be told from ports nobody has sorted yet.", "fix": "split the group by family, or add `mixed:` naming the job they share", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L24", "scope": "device", "rule": "`attrs.other` is counted so the long tail cannot go quiet", "why": "Keys left in the catch-all section are counted on every run, so the catch-all cannot quietly become the place anything awkward is put.", "fix": "file each key under its section where one fits; otherwise leave it and accept the count", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L25", "scope": "device", "rule": "one attr key is claimed by one section", "why": "Attribute sections flatten into one set of data attributes on the drawing, so two sections claiming one key would let one fact silently overwrite the other.", "fix": "rename one of the two; keys flatten to data-", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L26", "scope": "component", "rule": "every `class: cutout` element is backed by a conforming contract or a part that resolves to one", "why": "An opening with no standard part behind it has a size nothing checks, and the count keeps every such opening visible until a standard or a drawing is found for it.", "fix": "add `conforms`, or compose the std/ part that owns the aperture", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L27", "scope": "component", "rule": "a power-bearing module states its power figure or records that no document holds it", "why": "A power-bearing module with neither a figure nor a recorded absence leaves power totals short, with no record of which figures are missing.", "fix": "add `power-output-w` or `power-draw-max-w` from the guide's appendix, or leave the warning as the record", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L28", "scope": "component", "rule": "a power figure says which way it points and its min/typical/max are ordered", "why": "A bare watts figure cannot say whether a part supplies or draws power, and a minimum above its maximum is a transcription slip, so either would corrupt any power budget built from the library.", "fix": "use `power-output-w` for supplies and `power-draw-*-w` for consumers; never `watts`", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L29", "scope": "device", "rule": "a chassis says how many of the modules it accepts have no figure", "why": "A chassis whose modules lack figures would total to a small, confident, wrong power draw, so the count of modules with no figure travels with the total and marks it as a floor.", "fix": "walk the list; each is either in a document you missed or stays as the record", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L30", "scope": "device", "rule": "a card whose figure covers its paired module does not sit beside a module that also states its own", "why": "When a card's figure already includes its paired module and that module states its own, a sum over the bays counts the pair twice and gives a plausible over-count.", "fix": "decide which figure carries the pair and say so", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L31", "scope": "device", "rule": "a region's label matches the group or id it frames", "why": "A region label that disagrees with what the drawing puts there tells a reader a part is somewhere it is not.", "fix": "fix the label text or the region's members", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L32", "scope": "any yaml", "rule": "no mapping declares the same key twice", "why": "YAML keeps the last of two identical keys without a word, so whatever the first one said is lost before any rule or reader sees the file.", "fix": "remove the duplicate; YAML keeps the last silently", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L33", "scope": "device", "rule": "a bay reserves room for every module it accepts", "why": "A module larger than the bay that accepts it is either a part that cannot fit or a figure measuring something else, and either misleads someone planning a fit-out.", "fix": "size the bay to the largest `insert`/`size` it accepts, or remove the module from `accepts`", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L34", "scope": "device", "rule": "front and rear occupants sharing a slot column, in every configuration, fit around the midplane", "why": "Front and rear modules in one slot column can each look plausible yet together be deeper than the chassis, giving the 3D view and anyone planning a fit-out depths that cannot both be true.", "fix": "check the two depths against chassis depth; one of them is wrong, or the two cannot be seated together", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L35", "scope": "component", "rule": "a relief magnitude says where it came from", "why": "A relief depth with no stated source looks exactly like a measured one, so neither a reader of the 3D model nor the next contributor can tell a guess from a fact.", "fix": "add `confidence` and `source` to each `relief.features` entry", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L36", "scope": "component", "rule": "a `borrowed` relief magnitude names an origin that actually measured it", "why": "A borrowed depth claims another part measured it, so a borrowed guess, or a chain of them, would otherwise pass for a measurement in the 3D model.", "fix": "name a part whose own figure is `measured` or `photo-measured`, or use `estimated`", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L37", "scope": "component, device", "rule": "a group says what it is for and has members", "why": "Without a role nothing reading the drawing can tell the bays the box exists for from the ones that keep it running, and a group with no members promises parts that are not there.", "fix": "add `role`; delete a group nothing joins", "severity": "at-verified", "fails": false, "warns": true, "fails-at-verified": true }, { "code": "L38", "scope": "component", "rule": "printed text in a skin sits in `` unless the part is applied over the panel", "why": "Printing grouped as silkscreen is a layer of its own, so a drawing without the printing drops every legend and keeps the metal without relying on a sweep for loose text, and anything reading the skin can tell what is printed from what is cut.", "fix": "wrap the text nodes in the silkscreen group", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L39", "scope": "device", "rule": "the panel's holes agree with what goes in them: no overlap, standard sizes, no legend on a hole, every port has one where cutouts are declared", "why": "A hole that disagrees with its part draws metal the hardware does not have, misleading anyone checking the drawing against the real panel.", "fix": "fix the cutout size/position, or the placement; one wrong `ref` shows as many overlaps", "severity": "mixed", "fails": true, "warns": true, "fails-at-verified": false }, { "code": "L40", "scope": "device", "rule": "a pluggable cage says which optics run in it, and optics prose names a group that exists", "why": "A cage's shape says which optics fit, not which ones work, so someone fitting an optic to a port would have nothing to go on.", "fix": "add the group's optics attrs, or fix the group name in the prose", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L41", "scope": "device", "rule": "a bay or placement scoped to configurations names ones that exist, not all, not none", "why": "A typo in `only-in` drops a bay or part from the configuration it was meant for, and scoping to every configuration leaves the part out of one added later.", "fix": "fix `only-in`", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L42", "scope": "device", "rule": "a silkscreen mark says what it annotates, or `chassis` for printing about the whole unit", "why": "A legend with no owner cannot be checked for sitting beside its part or hidden by the module that covers it, and nothing reading the drawing can say what is printed next to a given port.", "fix": "add `for:`", "severity": "at-verified", "fails": false, "warns": true, "fails-at-verified": true }, { "code": "L43", "scope": "device", "rule": "a front or rear view as wide as the rack face still has its ears in it, unless the device is a `rack-face` part, which is its ears, states `chassis.ears: behind` (or `ears: {behind: true}`), whose face is the part, or has a body as wide as the rack (a blanking plate, whose ears are built into the face)", "why": "The library draws the metal between the ear folds, and the ears are added from the chassis, so a face measured across the ears puts every port off by an ear's width and gives the rack a body wider than the opening it fits.", "fix": "model the body between the ear folds; record the ear extent in provenance", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L44", "scope": "device", "rule": "panel decor agrees with the face: a patterned field is not buried under parts, printing does not run off the edge, no decor lies wholly off the face", "why": "Decor that is buried under parts, runs off the face, or lies wholly off it shows vents or printing the real panel does not have, and usually means something was mismeasured.", "fix": "move or trim the decor", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L45", "scope": "device", "rule": "a view at `modelled` draws something or declares itself empty", "why": "A face that only declares a size is not drawn, so the device would claim more than it shows unless the author records why the face stays empty.", "fix": "add content, or an `empty:` sentence of 40+ characters saying where you looked", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L46", "scope": "component", "rule": "composed parts do not collide inside the part", "why": "Two parts composed into the same place render as doubled or buried detail, such as one cage stacked over another, which a reader would take for real hardware.", "fix": "move a part, or say in provenance that the layering is deliberate", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L47", "scope": "component", "rule": "a state nothing draws is not declared", "why": "The viewer would offer a lamp state, such as fault, that changes nothing when chosen, because no drawn lamp takes the state's colour.", "fix": "draw a lamp element for the state, or remove the state", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L48", "scope": "component", "rule": "a bay the contract declares is drawn by a skin", "why": "With no drawn element for the bay a seated module has nothing to nest under, so the explorer hangs it off the chassis rather than inside the part that holds it.", "fix": "draw the bay opening in every skin, or remove the bay", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L49", "scope": "device", "rule": "members of one group, cut to one size, sit on one pitch", "why": "Uneven spacing among same-size members of one group is nearly always a misreading, and drawn as found it puts modules where the hardware does not.", "fix": "re-measure; an uneven pitch is usually a mis-read, not a finding", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L50", "scope": "component", "rule": "printing inside a skin is legible at the size it is set", "why": "Printing that runs off the edge of the part, or is covered by something drawn after it, is printing the reader cannot see while the drawing claims it is there.", "fix": "raise the font size or drop the text", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L51", "scope": "component", "rule": "a class has a power role in spec/schemas/power-roles.yaml", "why": "A class with no power role is never asked for a figure, so a power total quietly counts an unknown part as zero and presents a lower bound as the total.", "fix": "add the class under `draw`, `supply` or `passive` in power-roles.yaml", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L52", "scope": "component", "rule": "a stated power figure says where it was read from", "why": "Vendor power figures vary with conditions, so a number with no source cannot be rechecked or tied to the row it came from.", "fix": "add the provenance key the message names", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L53", "scope": "device", "rule": "content changed without the version bump the change requires (see devicelock)", "why": "Without it, a drawing someone has cached or imported goes stale without notice: a moved slot breaks a saved coordinate just as a renamed id breaks a saved reference.", "fix": "bump `version`: patch for wording, minor for additions, major for geometry or ids", "severity": "at-verified", "fails": false, "warns": true, "fails-at-verified": true }, { "code": "L54", "scope": "device", "rule": "a gap's scope names a group, view, configuration, id or attribute the device has", "why": "A gap scoped to something renamed or never declared would be read as applying to a part of the device that does not exist.", "fix": "fix the `scope`, or drop it", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L55", "scope": "library", "rule": "every vendor namespace is in spec/schemas/vendors.yaml", "why": "A namespace missing from the registry breaks the link from the name on the metal to the company that owns it now, so a search under the current name finds nothing.", "fix": "add the vendor to the registry with display, role and source", "severity": "mixed", "fails": true, "warns": true, "fails-at-verified": false }, { "code": "L56", "scope": "listing", "rule": "a listing sits under a software vendor in spec/schemas/vendors.yaml and lists a device that exists - every configuration it overrides, port it names and component it maps is the hardware's", "why": "A listing that names a port, configuration or part the hardware lacks would export interfaces and modules to a DCIM that no box has.", "fix": "register the NOS vendor with role software, point `hardware` at a device's /, and name only configurations and ids that device declares", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L57", "scope": "device", "rule": "exactly one configuration is `kind: base`, and each says whether it is orderable", "why": "Without a kind on each configuration the DCIM export can name a device type after an illustration rather than an orderable chassis, and the drawing can open on something nobody can buy.", "fix": "set `kind` on every configuration", "severity": "mixed-at-verified", "fails": true, "warns": true, "fails-at-verified": true }, { "code": "L58", "scope": "component", "rule": "a cage's own connection point agrees with the aperture inside it", "why": "When the two points disagree, a cable drawn to the declared point and a module seated on the aperture's point end up in different places.", "fix": "move the connection point to the composed aperture's", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L59", "scope": "device", "rule": "SKUs live on configurations, not at the top level", "why": "The DCIM export reads part numbers per configuration, so it never sees SKUs left at the top level: one already on a configuration is a second copy that can go stale, and one on none is an orderable build missing from the export.", "fix": "move `part-numbers` into the configuration they belong to", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L60", "scope": "device", "rule": "a face that declares itself empty is actually bare", "why": "A face declared empty counts as finished without drawing anything, so a stale claim would contradict the drawing and pass the face on false grounds.", "fix": "remove the `empty:` or the content; not both", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L61", "scope": "device", "rule": "a legend is centred on the thing it names, or plainly not trying to be", "why": "A legend a fraction of a millimetre off the part it labels looks wrong to anyone who zooms in.", "fix": "centre it, or move it clear", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L62", "scope": "device", "rule": "an id names the connector the way the rest of the library does", "why": "An id that names the connector rather than its job becomes false when the part changes, and two correct models of one device end up with different names for the same port, so references and exported interface names drift.", "fix": "use the convention the message quotes (e.g. `port-N`, `led-port-N`)", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L63", "scope": "device", "rule": "a configuration binds each face to a view that draws that face; a hole is derived from its part, not drawn around it", "why": "A face bound to a missing view, or to another face's view, makes an impossible front and rear pairing look declared, and a hole drawn around its part is a second record of the opening that can disagree with the first.", "fix": "fix the `views` binding, or derive the cutout from the placement", "severity": "mixed", "fails": true, "warns": true, "fails-at-verified": false }, { "code": "L64", "scope": "device", "rule": "nothing is bolted to, or printed on, an air hole", "why": "A vent field is open air, so a legend placed on it is printed on nothing and a jack is mounted to nothing.", "fix": "move the part or the mark off the vent field", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L65", "scope": "component", "rule": "a DC power part with nothing seated states what it can pass", "why": "On a DC chassis a power entry module is the only way power gets in, so if it states no rating nothing says how much power the chassis can take.", "fix": "add `power-output-w` for the PEM/terminal", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L66", "scope": "device", "rule": "a power group with more than one bay states its redundancy", "why": "Two supplies mean either double the capacity or one plus a spare, so someone adding up the bays could provision for twice what the box can rely on.", "fix": "add `attrs.redundancy` (e.g. `1+1`) and a `redundancy-note` citing the guide", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L67", "scope": "device", "rule": "a control-plane or fabric group with more than one bay states its redundancy", "why": "Someone counting control or fabric cards would take a standby spare for working capacity and overstate the headroom.", "fix": "as L66, for the RE/RP/fabric group", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L68", "scope": "library", "rule": "a measurement keeps one attr name and one section across the library", "why": "A comparison that cannot find one spelling shows a blank or a wrong figure with nothing to warn the reader, and a key filed under different sections cannot be found by section.", "fix": "use the name the message quotes", "severity": "mixed", "fails": true, "warns": true, "fails-at-verified": false }, { "code": "L69", "scope": "device", "rule": "a cooling group with more than one bay says how many fans it can lose", "why": "Without a stated figure nobody comparing devices or planning cooling can tell how many fans the box can lose and keep running.", "fix": "add `attrs.redundancy` (e.g. `n+1`) and a note", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L70", "scope": "device", "rule": "a `fact:` gap names a real fact and does not contradict the device", "why": "A gap scoped to a misspelt fact leaves the comparison showing a bare blank although the search was done, and a device that states a figure while calling the vendor silent on it shows a number and a retraction at once.", "fix": "fix the gap's scope or remove it", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L71", "scope": "component", "rule": "a body box reaches no further than the part says it is deep; a round one states its axis (a ring its wall) and is square across it; one that `shows` a drawing is a box of a part declaring that face", "why": "A body box deeper than the part gives the wrong bay hole, pull distance and fit checks, and a round piece with no axis or a non-square section builds as an oval in 3D.", "fix": "shrink the body box or raise `body.depth`; state `axis`/`wall` or square the envelope; declare the face or drop `shows`", "severity": "mixed", "fails": true, "warns": true, "fails-at-verified": false }, { "code": "L72", "scope": "device", "rule": "a bay's `plan:` or `rear:` lands in a view that exists, inside the chassis", "why": "A bay projected into a view or neighbour that does not exist draws nothing and raises nothing, so the plan or rear view silently loses the part.", "fix": "fix the plan view name or the coordinates", "severity": "mixed", "fails": true, "warns": true, "fails-at-verified": false }, { "code": "L73", "scope": "component", "rule": "a field prints somewhere, and what prints is a field; a node a field paints states no relief `color`, so its 3D sides follow the field", "why": "A form would offer a field that changes nothing on the drawing, or the drawing would paint from a value no form can set, and a fixed relief colour leaves a field-painted part's 3D sides the wrong colour.", "fix": "add a `data-from` text node for each field, or remove the field; drop a relief feature's `color` on a field-painted node", "severity": "mixed", "fails": true, "warns": true, "fails-at-verified": false }, { "code": "L74", "scope": "component", "rule": "a lamp that declares states is painted from the lamp-colour variable", "why": "A lamp painted in a literal colour ignores every state its contract declares, so in 2D and 3D it can never light the way the viewer says it does.", "fix": "fill or stroke the lamp node with `var(--led-color, )`, not a literal colour", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L75", "scope": "component", "rule": "a slot's structured facts agree with its prose, and lanes fit the connector", "why": "A slot's prose and its structured facts would drift apart, so a reader and the card-fit check would see different slots, and a lane count wider than the connector is a typo, not a slot.", "fix": "fix `lanes`/`connector` or the description", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L76", "scope": "device", "rule": "the RJ45 census: every Ethernet jack says whether it has lamps", "why": "Every Ethernet jack has to answer whether it has link lamps the same way, or a drawing can leave out lamps the hardware has, or add them to a console jack, and the viewer cannot light them consistently.", "fix": "use std/rj45@2 with the lamp parts, or say in provenance the jack is bare", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L77", "scope": "component", "rule": "a `sink` sits in a cavity, because that is what it measures from", "why": "A sink with no cavity above it has no floor to measure from, so the recess is declared but never built in 3D, and nothing reports it.", "fix": "use `pocket` for a recess in an otherwise solid face", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L78", "scope": "component", "rule": "an optical endpoint names a composed connector and a position it has; a front order that names a part's positions names each once, together; a trunk entry names a connector on this face and a position it has", "why": "An optical endpoint, front order or trunk entry that names a missing part or position describes a fibre that does not exist, so ports are left unnumbered or numbered twice.", "fix": "fix the part id or the position number; list every position of the part, or name it bare", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L79", "scope": "component", "rule": "no fibre position is claimed twice, and a split's ratios sum to 100; a source starts one path, unless every path it starts but one carries a `band` (an add/drop filter)", "why": "Two paths into one bore describe something no ferrule allows, and ratios that do not add to 100 describe a split that cannot exist.", "fix": "remove the duplicate path, or fix the ratios; write a split as one path with a ratio list", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L80", "scope": "component", "rule": "every fibre position is reached by a path or declared unused with a reason", "why": "A fibre position nothing reaches cannot otherwise be told from a deliberate dead end, so a missed path would pass as a design choice.", "fix": "route it, or add an `optical.unused` entry saying why it terminates nothing", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L81", "scope": "component", "rule": "a composed pitch respects the standard the part conforms to - equal for a target, no narrower for a floor", "why": "Connectors set closer than their standard allows, or off its fixed pitch, draw a port array a mating plug or neighbouring module would not line up with.", "fix": "move a target onto the standard's pitch, widen a floor to at least it, or say in provenance why this part differs. Where the placements share an x, make their `rotate` agree so a rotated column can be told from a stacked pair", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L82", "scope": "component", "rule": "a part names its plan drawing one way or the other, never both", "why": "Two copies of one plan reference agree only until someone edits one and misses the other, and then every reader has to guess which copy counts.", "fix": "keep `plan:` or `faces.plan`, not both - they mean the same thing", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L83", "scope": "component", "rule": "a declared face names a real component, is not the part itself, and that component has no face of the same direction", "why": "A face ref with a typo draws nothing while the contract still lints, and a face that names its own part, or a direction the named part already has, means the wrong part is drawn.", "fix": "fix the ref, or drop the face it names if the chain has no meaning", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L84", "scope": "component", "rule": "a face-qualified optical endpoint names a face the part declares", "why": "An endpoint qualified with a face the part does not declare resolves to nothing, and its fibre drops out of the map.", "fix": "add the face to `faces:`, or fix the prefix on the endpoint", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L85", "scope": "component", "rule": "only a face that is another side of the module draws fibres of its own", "why": "A connector drawn on a face that is only another view of the same module is not counted, so it is either the front's port drawn twice or a real port missing from the fibre map, and nothing says which.", "fix": "move the connector onto the face that really carries it, or extend `faces.OPTICAL_FACES` if this direction genuinely is another side", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L86", "scope": "component", "rule": "a module composing a connector the enum spells two ways states its polish", "why": "Without a stated polish a module of LC or similar adapters has no port type a DCIM import can take, because the type is spelled UPC or APC.", "fix": "add `optical.polish: upc` or `apc`, and say in provenance where it came from", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L87", "scope": "component", "rule": "a module naming what its rear IS has a rear face to name", "why": "A rear kind on a module with no rear face describes a drawing that does not exist, so the export writes nothing for that side and nothing says so.", "fix": "add `faces.rear`, or drop `optical.rear-kind`", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L88", "scope": "component", "rule": "a fibre face with more than one row of connectors states its own front numbering", "why": "On a face with more than one row of connectors, numbering by position alone guesses the vendor's printed order, so DCIM front ports could be numbered differently from the silkscreen.", "fix": "add `optical.front-order` listing the fibre part ids in the vendor's printed order", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L89", "scope": "library", "rule": "every component major is reachable from a device, or says why it is not", "why": "A part nothing seats would look in the catalogue exactly like one in use, so a reader could choose a part no drawing has ever shown in place.", "fix": "seat it in a device or in a seated part's bay, or add `unplaced:` saying what would seat it and what is missing", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L90", "scope": "device", "rule": "a manifest's top-level keys read in the canonical order", "why": "Keys in one order across every manifest let a reviewer compare two devices line by line, and a contributor copying a neighbour copies the canonical layout rather than an accident.", "fix": "reorder them; the message prints the order, and docs/device-template.yaml is written in it", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L91", "scope": "device", "rule": "airflow is stated once - on the chassis, and on a configuration only where it differs", "why": "Airflow stated in two places drifts, so a change to the chassis could be masked by stale copies, and a reader cannot tell a real difference between builds from repetition.", "fix": "move it to `chassis.airflow`, or drop the configuration's copy", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L92", "scope": "component", "rule": "a part's size says where it came from", "why": "Cutouts, bay sizes and pitches are derived from a part's size, so an unsourced size spreads unchecked into everything built on it.", "fix": "add a `size:` provenance note; the key for a size is `size`, not a sentence about it", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L93", "scope": "device", "rule": "a provenance entry says how the figure is known, not only where it was read", "why": "Without a confidence word nobody can ask which figures are estimated and which were measured, so an estimate reads like a measurement.", "fix": "add `confidence:` beside the note, from the eight words in the confidence enum", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L94", "scope": "device", "rule": "a `component-attrs` key names a component the device seats, or a placement or bay it declares", "why": "A key that matches nothing renders exactly as if the line were missing, so a typo silently drops a setting someone meant to make.", "fix": "fix the key; one that matches neither sets nothing and is silently ignored", "severity": "error", "fails": true, "warns": false, "fails-at-verified": false }, { "code": "L95", "scope": "component", "rule": "a power supply says where power enters it", "why": "A supply that does not say where power enters it exports no power port, so a DCIM shows supplies with nothing to cable.", "fix": "compose an inlet part, or add `attrs.inlet` from the enum - `none` if the chassis carries it", "severity": "warning", "fails": false, "warns": true, "fails-at-verified": false }, { "code": "L96", "scope": "component", "rule": "a module composing a pluggable cage says what rate it runs at", "why": "A card that does not state its cages' rate is exported with a default, so a DCIM can show 10G interfaces on a card that is 1G, with nothing to tell a right default from a wrong one.", "fix": "add the media attr for that family - `sfp`, `sfp-plus`, `qsfp`, `qsfp28`, `qsfp-dd`, `xfp-10g` - with the port count; a cage carrying a proprietary link no rate names takes `proprietary-link: