Files
AgentHub/server/openapi-extra.js
T
nntrivi2001 57f02f0d89 docs: OpenAPI and API.md cover every route; drop removed endpoints; guard config writes
- openapi-extra/run.js describes tmux pane runs only: the removed
  POST /api/run/{id}/message and stream-json run_stream/run_input_ack are gone.
- 108 operations added to OpenAPI (lanes, run, settings, reports, cc-config,
  pets, ai-proxies, tool-profiles, ai-tools, snapshots, locks, ...);
  openapi.yaml regenerated.
- docs/API.md: 74 routes added, 4 endpoints that no longer exist removed.
- Role is `developer`, not `member` (CLI.md, DATABASE.md, OVERVIEW.md);
  `agenthub update` -> `update-check`; help lists `server install-system|tools`
  and `users provision`; ARCHITECTURE.md's stale paths and names fixed.
- cc-config/codex-config writes carry sameOriginGuard (an MCP server or plugin
  is code Claude runs later), with a test; `command -v` takes its name as $1.
2026-10-22 12:17:18 +07:00

74 lines
2.8 KiB
JavaScript

/**
* @file Supplementary OpenAPI fragments merged into the base spec by
* `createOpenApiSpec()` (server/openapi.js). Each domain fragment under
* `server/openapi-extra/` exports `{ tags, schemas, paths }`; this module
* deep-combines them into one `{ tags, schemas, paths }` object. Extra paths
* and schemas OVERRIDE base entries with the same key, so a comprehensive
* entry here can supersede a terser one in the base literal; tags are appended
* only when their `name` is not already present.
* @author Nguyễn Ngọc Trí Vĩ <vinnt@smartgift.vn>
*/
// New endpoint groups (previously-undocumented gaps in the base spec).
const ccConfig = require("./openapi-extra/cc-config");
const codexConfig = require("./openapi-extra/codex-config");
const run = require("./openapi-extra/run");
const lanes = require("./openapi-extra/lanes");
const push = require("./openapi-extra/push");
const aiTools = require("./openapi-extra/ai-tools");
const misc = require("./openapi-extra/misc");
const auth = require("./openapi-extra/auth");
const files = require("./openapi-extra/files");
const artifacts = require("./openapi-extra/artifacts");
// Routes the spec had missed (audit 2026-10-22): new path keys only — a key
// that already existed got its missing method in place instead.
const lanesMore = require("./openapi-extra/lanes-more");
const toolsMore = require("./openapi-extra/tools-more");
const opsMore = require("./openapi-extra/ops-more");
// Enriched overrides of already-documented endpoints — same operationId, tags,
// and request/response `$ref` schemas as the base, with added examples and
// richer descriptions. Listed last so they win the merge.
const overrideSessionsAgents = require("./openapi-extra/override-sessions-agents");
const overrideCore = require("./openapi-extra/override-core");
const overridePricingAlerts = require("./openapi-extra/override-pricing-alerts");
const overrideOps = require("./openapi-extra/override-ops");
/** Combine N fragments into a single { tags, schemas, paths }. Later fragments
* override earlier ones on path/schema key collisions; tags dedupe by name. */
function combine(...fragments) {
const out = { tags: [], schemas: {}, paths: {} };
const tagNames = new Set();
for (const frag of fragments) {
if (!frag) continue;
for (const tag of frag.tags || []) {
if (tag && !tagNames.has(tag.name)) {
tagNames.add(tag.name);
out.tags.push(tag);
}
}
Object.assign(out.schemas, frag.schemas || {});
Object.assign(out.paths, frag.paths || {});
}
return out;
}
module.exports = combine(
ccConfig,
codexConfig,
run,
lanes,
push,
aiTools,
misc,
auth,
files,
artifacts,
lanesMore,
toolsMore,
opsMore,
overrideSessionsAgents,
overrideCore,
overridePricingAlerts,
overrideOps
);