Refactor code structure for improved readability and maintainability
This commit is contained in:
16
docs/api/graph/overlay-schema.md
Normal file
16
docs/api/graph/overlay-schema.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# Graph Overlay & Cache Schema (draft placeholder)
|
||||
|
||||
**Status:** TODO · awaiting Graph Platform Guild ratification
|
||||
|
||||
## Scope
|
||||
- Overlay/cache schema for graph tiles used by Web gateway and UI overlays.
|
||||
- Validation rules for bbox/zoom/path; pagination tokens; deterministic ordering.
|
||||
- Error codes and sampling/telemetry fields.
|
||||
|
||||
## Needed from owners
|
||||
- JSON schema (or OpenAPI fragment) for overlay response and cache metadata.
|
||||
- Allowed zoom levels/coordinate system; max nodes/edges per tile; hashing/etag rules.
|
||||
- Sample overlay bundle (happy path + rate-limit + validation error).
|
||||
|
||||
## TODO
|
||||
- Insert ratified schema + samples; note schema hash/date; link from Web II sprint log.
|
||||
Reference in New Issue
Block a user