-
Notifications
You must be signed in to change notification settings - Fork 21
Open
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
Summary
Documentation and API responses are out of sync with code after logging endpoints, merge pipeline, and plugin system changes landed on main.
Broken for users (docs):
tutorials/manifest-discovery.rstdocumentsconfig.unmanifested_nodeswith 4 policies (ignore/warn/error/include_as_orphan) - this parameter does not exist. Replaced bydiscovery.merge_pipeline.gap_fill.*.
Missing documentation:
config/server.rstmissing Logging (logs.buffer_size) and Rate Limiting (rate_limiting.*) config sectionsconfig/discovery-options.rstmissing entire merge pipeline section (gap_fill, layer policies, field groups)tutorials/plugin-system.rstmarks IntrospectionProvider as "preview/not yet wired" (now wired via PluginLayer) and is missing LogProviderapi/rest.rstserver capabilities example response wrong format and outdated
Code bugs (handle_root / version-info):
GET /api/v1/missing entire endpoint categories: logs, bulk-data, cyclic-subscriptions, updatesGET /api/v1/capabilities JSON missing: logs, bulk_data, cyclic_subscriptions, updatesGET /api/v1/lists ghost snapshot endpoints with no registered routes- Version hardcoded as "0.1.0" in handle_root and version-info (should be 0.3.0)
GET /version-infousessovd_infokey instead of SOVD-standarditems- Entity capability responses missing
bulk-data,logs,cyclic-subscriptionsURIs
Proposed solution
Update docs, fix handle_root/version-info responses, add missing entity capability URIs, update tests.
Additional context
Changes landed between 0.3.0 (Feb 27) and current main: logging endpoints (#245), merge pipeline, plugin system IntrospectionProvider wiring, LogProvider interface.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentation