LINKGRID API overview
A proposed local interface specification, not a hosted API or production SDK.
Concept documentation. Not a production specification. API examples are illustrative, not hosted services.
Proposed interface only
This article sketches an illustrative interface for a local topology tool. It is not an operational remote API, published SDK or promise of backend availability. There is no service URL, API key, account system or authentication flow. The website's actual demo state is managed inside its React components, with pure graph functions used for topology creation and path search.
Suggested domain types
A node needs a stable identifier, a human-readable name and a role. A link needs endpoint identifiers and a state whose meaning is explicit. An event should record what changed without claiming that a browser simulation observed a physical device. Future production schemas would also need versioning, source attribution, freshness and access-control rules.
// Proposed local interface; not an installed SDK.
type Node = { id: string; name: string; role: string };
type Link = { source: string; target: string };
type PathResult = { nodes: string[]; simulated: true };
Illustrative operations
A proposed getTopology operation would return the selected fixture. selectNode would validate an identifier before changing an inspector. highlightPath would require two distinct endpoints and return a connected route or an empty result. simulatePacket would record a local demonstration event and animate that route only when motion policy permits.
The actual pure graph module exposes graph(preset) and findPath(nodes, links, source, target). These functions are implementation details in this source repository, not a supported public library. The path function returns an empty array for invalid, identical or disconnected endpoints. Consumers must distinguish those outcomes with their own user-facing explanation rather than treating an empty result as successful delivery.
Error semantics matter
A production API should not hide an invalid identifier behind a fabricated default node. Unknown state, no route and permission failure are different conditions. Decide whether operations are idempotent, how topology versions are represented and how stale observations are communicated. None of those production guarantees is provided by this conceptual proposal.
Integration example boundary
A local interface could retrieve a fixture, validate source and destination, compute a path, then update the view atomically. That sequence should not send form data or contact external services. Network packet animation is a user-interface effect, not transport delivery confirmation. Copy any examples as educational material only. Read monitoring for data interpretation and LINKGRID for the current demonstration lifecycle. Real backend development would require security review, server validation, tests and an explicit deployment contract.