Files

Gustavo Madeira Santana ff97195500 Gateway: add path-scoped config schema lookup (#37266 )

Merged via squash.

Prepared head SHA: 0c4d187f6fb66f2799d4047585d6368e433c883a
Co-authored-by: gumadeiras <5599352+gumadeiras@users.noreply.github.com>
Co-authored-by: gumadeiras <5599352+gumadeiras@users.noreply.github.com>
Reviewed-by: @gumadeiras

2026-03-06 02:50:48 -05:00

1.4 KiB

Raw Blame History

summary, read_when, title

summary	read_when	title
RPC protocol notes for onboarding wizard and config schema	Changing onboarding wizard steps or config schema endpoints	Onboarding and Config Protocol

Onboarding + Config Protocol

Purpose: shared onboarding + config surfaces across CLI, macOS app, and Web UI.

Components

Wizard engine (shared session + prompts + onboarding state).
CLI onboarding uses the same wizard flow as the UI clients.
Gateway RPC exposes wizard + config schema endpoints.
macOS onboarding uses the wizard step model.
Web UI renders config forms from JSON Schema + UI hints.

Gateway RPC

wizard.start params: { mode?: "local"|"remote", workspace?: string }
wizard.next params: { sessionId, answer?: { stepId, value? } }
wizard.cancel params: { sessionId }
wizard.status params: { sessionId }
config.schema params: {}
config.schema.lookup params: { path }

Responses (shape)

Wizard: { sessionId, done, step?, status?, error? }
Config schema: { schema, uiHints, version, generatedAt }
Config schema lookup: { path, schema, hint?, hintPath?, children[] }

UI Hints

uiHints keyed by path; optional metadata (label/help/group/order/advanced/sensitive/placeholder).
Sensitive fields render as password inputs; no redaction layer.
Unsupported schema nodes fall back to the raw JSON editor.

Notes

This doc is the single place to track protocol refactors for onboarding/config.

1.4 KiB Raw Blame History

Onboarding + Config Protocol

Components

Gateway RPC

UI Hints

Notes

1.4 KiB

Raw Blame History