docs: effective configuration and dry-run validation - #5
Merged
Merged
Conversation
Coherent connection and flow examples; open base objects so generators can extend them; sampled_at on traffic; src and connection_id filters; GroupSummary.config_revision; probe queue-full 503 with Retry-After; health identity carries measurement; decision-time names in selection paths; CORS, datapath and cursor rules stated once.
Example timestamps fall after instance start; the preflight rule is stated in api-config and common; health identity keeps warmth; wording.
chain, rule, ingress and domain source with provenance on Connection and FlowSummary; GET /runtime/outbounds; bounded GET /runtime/traffic/history; no-close and out-of-scope statements.
ErrorCode enum on HTTP error bodies (ApiError); errors embedded in resources keep adapter-defined codes; /events 409 names event_cursor_expired and carries an example.
GET /api/v1/config returns the accepted sources (content only when resources.config.content is true), diagnostics and generation; POST /api/v1/config/validate dry-runs candidate sources in syntax or full mode. Two capability keys, discovery links, docs and eight tests. Writing configuration is a later contract change.
GET and PUT /api/v1/config/sources/{source_id}: full-text replacement
of one writable source with If-Match on content_sha256 (428/412), full
validation first (422 with diagnostics, nothing written), atomic write,
then a 202 reload operation. Writability flags on capabilities and
sources; six tests.
Contributor
Author
|
Second commit adds editing: |
This was referenced Sep 16, 2026
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the two endpoints the doona Config and Validate pages need. Stacked on #4 (branch
ui-findings); merge that first.GET /api/v1/config: the effective configuration as one snapshot:generation_id,revision, the accepted sources (id, path, kind, content_sha256, bytes, loaded_at, line_count;contentonly whenresources.config.contentis true), diagnostics with nullable one-based line/column and end-exclusive spans,secrets_redacted.x-permission: observe.POST /api/v1/config/validate: dry-run of candidate sources insyntaxorfullmode; returnsvalid, the same diagnostic shape, the runninggeneration_idandvalidated_at; no state change, no network.x-permission: control; 413 overmax_bytes/max_sources.resources.configandresources.config_validate, discovery links,configuration.md, honk mapping rows, eight contract tests.Writing configuration is deliberately not in this PR.
npm run check:contract: 38 pass, 88 examples validated.