Skip to content

v0.2.0 — Plan/data mode contract and agent-friendly query envelope

Latest
Latest

Choose a tag to compare

View all tags
@qiansheng91 qiansheng91 released this 10 Jun 13:03
· 4 commits to main since this release
v0.2.0
60b3a45
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Highlights

  • Plan/data mode protocol on Query Service. ?mode= and a new GET /api/v1/capabilities endpoint let clients ask for a query plan or data execution. This open-source surface stays plan-only by design; mode=data is rejected with structured migration_* details an agent can act on without parsing prose.
  • Plan JSON v1 contract, documented as a versioned spec (docs/en/spec/plan-schema-v1.md). Plans now carry mode, version, operation, description, next_action, source_query, params_echo, data_source, query, and time_range. Breaking changes are gated by a v2 RFC.
  • Plan schema v1.1 agent-friendly envelope. ?format=agent returns the plan as a top-level JSON object (no envelope, no string-encoded plan), with data_source.* folded to compact {ref, kind} references. ?include=spec opts back into the full storage.config, data_link.spec, storage_link.spec for debugging and diagnostic agents.
  • get_metrics / get_logs plan emission with entity-level filters, rendered against PromQL / Elasticsearch DSL.
  • EntitySet dataset discovery via the new list_data_set entity-call.
  • Multi-domain quickstart sample expanded with devops log_set, metric_set, event_set, storage, and links.

What's new

Added

  • Plan/data mode protocol on Query Service (#25)
  • Plan JSON v1 contract and shared specification (#25)
  • Plan schema v1.1 agent-friendly response envelope: ?format=agent, compact refs, ?include=spec opt-in (#26)
  • get_metrics / get_logs plan emission with entity filters (#18, #23)
  • Aligned method signatures for get_metrics / get_logs — aggregate, storage_domain, storage_name, storage_kind (#25)
  • EntitySet dataset discovery via list_data_set (#17)
  • Multi-domain quickstart sample pack expanded with devops log_set / metric_set / event_set and supporting storage and links
  • Web UI improvements — workspace routing with UModel URLs (#15), Query Page example picker and result table (#21), full internationalization, Monaco editor preload, API Debugger panel, Imports feature, Settings refresh
  • Issue and PR templates (#28)

Changed

  • Documentation index gained a Specifications section under docs/en/README.md and the Chinese mirror, pointing at the new plan schema spec
  • Plan output's params_echo strips nil and empty-string entries; method-signature defaults are echoed only when the caller actually supplied them

Fixed

  • Local Ladybug provider could lose workspace metadata across service restarts (#22); recovery now reads metadata back from the data root
  • Dependabot alerts on Vite resolved (#16)
  • LICENSE file restored to canonical Apache 2.0 form so GitHub's Licensee scanner can detect the license; project copyright moved to a new NOTICE file per Apache 2.0 §4(d) convention (#27)

Security

  • Reaffirmed: MCP write tools remain disabled by default. Security reporting policy unchanged.

Compatibility

Plan schema is purely additive within v1. Existing consumers see exactly the v1 envelope they saw before unless they opt in to ?format=agent (which returns v1.1). SDKs and CLIs that hardcoded mode assumptions should adopt GET /api/v1/capabilities for discovery — see the spec for the contract.

A v2 (breaking) revision would require an RFC and a migration window — see docs/en/spec/plan-schema-v1.md §4.

Full changelog

v0.1.0...v0.2.0

Assets 2
Loading