Gateway: add generated config OpenAPI + Mintlify API reference#27659
Draft
vincentkoc wants to merge 17 commits intoopenclaw:mainfrom
Draft
Gateway: add generated config OpenAPI + Mintlify API reference#27659vincentkoc wants to merge 17 commits intoopenclaw:mainfrom
vincentkoc wants to merge 17 commits intoopenclaw:mainfrom
Conversation
18 tasks
Member
Author
|
Follow-up docs gap PR (draft): #28196 Context: while cross-checking the generated config metadata/OpenAPI artifacts from this branch, we found stale key paths in This follow-up updates those docs paths to match current config metadata naming ( |
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
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.
Summary
Describe the problem and fix in 2–5 bullets:
openclaw.jsonkeys or verify docs against runtime schema./v1/config/schema,/v1/config/keys,/v1/config/validate), generators for schema/spec/docs artifacts, and Mintlify OpenAPI wiring viadocs/docs.json.Change Type (select all)
Scope (select all touched areas)
Linked Issue/PR
User-visible / Behavior Changes
List user-visible changes (including defaults/config).
If none, write
None.GET /v1/config/schemaGET /v1/config/keysPOST /v1/config/validatedist/config.schema.jsondist/config.uihints.jsondist/config.keys.jsondist/config-http.openapi.jsondocs/openapi/config-http.openapi.jsondocs/gateway/config-http-api.mddocs/gateway/configuration-schema-reference.mddocs/docs.jsonapi.openapiconfig.Security Impact (required)
Yes/No) YesYes/No) NoYes/No) YesYes/No) NoYes/No) YesYes, explain risk + mitigation:Repro + Verification
Environment
gateway.auth.mode=tokenSteps
pnpm config-spec:gen./v1/config/schema,/v1/config/keys,/v1/config/validate.pnpm config-spec:checkandpnpm check:docs.Expected
Actual
Evidence
Attach at least one:
Human Verification (required)
What you personally verified (not just CI), and how:
pnpm vitest run --config vitest.gateway.config.ts src/gateway/config-http.test.ts(5/5 passing)pnpm config-spec:checkpassingpnpm check:docspassing (broken_links=0){ config: ... }Compatibility / Migration
Yes/No) YesYes/No) NoYes/No) NoFailure Recovery (if this breaks)
src/gateway/config-http.ts,src/gateway/server-http.ts,docs/docs.json, generated artifacts.pnpm config-spec:checkdiff churndocs/openapi/config-http.openapi.jsonRisks and Mitigations
List only real risks for this PR. Add/remove entries as needed. If none, write
None.config-spec:docsnow formats generated files, andconfig-spec:checkenforces sync.