Document the derivation method and the vendor-dependency boundary
Two things the guide asserted without explaining.
HOW IT WAS BUILT. The models were derived from Plex's own published API
documentation on developers.plex.com — a public, unauthenticated documentation
API that effectively serves the OpenAPI documents. One call returns the whole
catalogue; one call per operation returns it expanded with typed parameters and
response schemas. 283 read contracts across 71 APIs, resolving to 359 distinct
response schemas, about 38 MB. A generator turns that into models: one per
distinct response schema, a Fuuz type per field, a relation wherever a reference
resolves to another modelled entity. Field-level fidelity is Plex's own, which
is why 191 fields say the vendor documents no description rather than restating
their own name.
THE VENDOR DEPENDENCY, which was one passing line and is now a section. Nothing
Plex changes propagates here. There is no live link between the portal and an
installed tenant; the schema is a snapshot of 2026-08-05 and stays that until
someone re-harvests and republishes. Stated as a property of the approach rather
than a defect — an accelerator that silently re-shaped itself when a vendor
edited their docs would be worse.
The table matters more than the statement: a removed endpoint 404s and gets
noticed the same day, while an ADDED field is silently discarded by the mapping
and a CHANGED KEY lands rows under new identities as duplicates rather than an
error. The dangerous changes are the quiet ones, so the page says which are
which, names rawPayload as the only signal that catches them, and puts ownership
of noticing with the customer or partner rather than leaving it unassigned.
Also surfaced on Home, added as a Discovery question, defined in the Glossary,
and reflected in Legal — the models describe the API as documented on a stated
date only, with no commitment to track the vendor on any schedule.
500 -> 619 lines. All cross-page anchors verified to resolve.
Customer & Partner Guide v0.6.0
Twelve pages built from ACCELERATOR-GUIDE-TEMPLATE.md, following the page split
in the system-log-dashboard worked example. Replaces the placeholder Home.
Every figure is read from the generated spec rather than recalled: 182 models,
4,560 fields, 465 forward relations, 283 reverse collections, 119 collection
endpoints, 63 sub-resources of which 23 are callable and 40 are not, 7 load
layers, 6 models with no reliable key, paging none/window/cap = 158/21/3.
Leads with the constraint that costs most if missed — one tenant per PCN,
because the primary key is the vendor's own key and two facilities both have a
PART-1000. States the three real limitations plainly rather than smoothing them.