文档：补全缺失的设计文档、LICENSE 和企业版说明#7
Open
Shicongcoding wants to merge 17 commits into
Open
Conversation
…ents Two design documents referenced in README but previously missing: - curated-commands.md: Design principles for the curated command system, including spec schema, argument/flag design, body mapping with transforms, auth constraint validation, and naming conventions. Includes comparison with kscc's MCP-first approach. - openapi-cli-mapping.md: Rules for mapping OpenAPI paths to CLI commands, covering resource extraction, verb normalization, path parameter handling, nesting depth limits, and the api escape hatch. Includes full audit of current 152-command coverage and pattern distribution. Co-Authored-By: Claude Opus 4.7 <noreply@owtffssent.com>
5 fixes from @祖冲之 review:
1. curated-commands.md: Fix YAML example — add `version: 1` + `commands:`
wrapper, correct indentation to match actual spec format
2. curated-commands.md: Correct coverage table — User ~10, Mail ~12
(was ~12 and ~15)
3. curated-commands.md: Mark `request_schema_ref` as optional (most
commands only have `response_schema_ref`)
4. openapi-cli-mapping.md: Clarify path parameter naming — always use
`{resource}-id` format, never strip `-id` suffix
5. openapi-cli-mapping.md: Change "649 unmapped paths" to "~649 paths
accessible only via api" to account for path sharing across methods
Co-Authored-By: Claude Opus 4.7 <noreply@owtffssent.com>
…openapi-cli-mapping.md design documents
- ARCHITECTURE.md：完整的项目架构文档，包括系统概览、目录结构、双轨命令体系、Spec发现与加载、认证架构、输出管道、全局标志和环境变量 - docs/faq/faq.md：常见问题解答，覆盖多维表图片链接获取、个人版使用限制、权限生效流程、密钥泄露处理、Agent集成方式 Co-Authored-By: Claude Opus 4.7 <noreply@owtffssent.com>
- 新增 LICENSE 文件（MIT），README 标注了 MIT 但文件缺失 - 新增 docs/design-docs/auth.md，描述双认证模式、凭证存储、 token 生命周期管理和安全考量 - 在 prerequisites.md 前置条件中说明需要 WPS 365 企业版， 并增加个人版 FAQ（关联 wps365-open#4） Co-Authored-By: Claude Opus 4.7 <noreply@owtffssent.com>
spec-discovery.md — 描述 spec 文件存储、自动下载、增量更新、 自定义覆盖与 OSH 网关 spec 的完整机制 testing.md — 描述闭源场景下的测试约束、dry-run 验证手段、 分层测试策略与文档贡献的链接检查方法 Co-Authored-By: Claude Opus 4.7 <noreply@owtffssent.com>
- 新增 OSH 网关认证模式（第三种模式，auth login --osh） - 补充 --redirect-uri 自定义回调地址说明 - 补充 WPS365_OSH_TOKEN 环境变量直接注入方式 - Token 生命周期表增加 OSH 列 - 明确 token endpoint URL Co-Authored-By: Claude Opus 4.7 <noreply@owtffssent.com>
- 新增常用 Scope 参考表（按业务域分组） - 修正 auth clean --force 为 auth clean（v0.1.0 无 --force 参数） Co-Authored-By: Claude Opus 4.7 <noreply@owtffssent.com>
…整性检查 Co-Authored-By: Claude Opus 4.7 <noreply@owtffssent.com>
spec-discovery.md: 增加自定义 spec 编写格式要求（API/精装）、 明确合并优先级为整体替换而非字段级合并、区分 WPS365_SPEC_BASE_URL 与 WPS365_API_BASE testing.md: 扩展退出码表（增加 exit 2/7）、增加幂等测试模式、 增加 GitHub Actions CI/CD 集成示例 Co-Authored-By: Claude Opus 4.7 <noreply@owtffssent.com>
… docs/complete-design-docs-and-license
Co-Authored-By: Claude Opus 4.7 <noreply@owtffssent.com>
Co-Authored-By: Claude Opus 4.7 <noreply@owtffssent.com>
合并拉格朗日和爱因斯坦两个版本的覆盖优先级说明， 保留双方优点：详细优先级表 + 整体替换语义说明 + 自定义命令编写指南和覆盖示例。 Co-Authored-By: Claude Opus 4.7 <noreply@owtffssent.com>
… docs/complete-design-docs-and-license
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
1 participant
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.
概要
仓库 README 引用了多份文档但实际不存在，本 PR 补全这些缺失内容：
测试计划
🤖 Generated with kscc