Variable WATCHER_CATALOGConst
WATCHER_CATALOG: Catalog<
readonly [
{
auth: AuthSpec;
description: `Get ${string} service health, version, and uptime.`;
kind: "read";
method: "GET";
name: "status";
path: "/status";
response: ZodObject<
{
health: ZodObject;
name: ZodString;
status: ZodUnion<
readonly [
ZodLiteral<"healthy">,
ZodLiteral<"degraded">,
ZodLiteral<"unhealthy">,
],
>;
uptime: ZodNumber;
version: ZodString;
},
$strip,
>;
},
{
auth: AuthSpec;
description: `Query ${string} running configuration. Optional JSONPath filter.`;
kind: "read";
method: "GET";
name: "config";
path: "/config";
query: ZodObject<{ path: ZodOptional<ZodString> }, $strip>;
response: ZodUnion<
readonly [
ZodObject<
{ count: ZodNumber; result: ZodArray<ZodUnknown> },
$loose,
>,
ZodObject<{}, $loose>,
],
>;
},
{
auth: AuthSpec;
body: ZodObject<
{
patch: ZodRecord<ZodString, ZodUnknown>;
replace: ZodOptional<ZodBoolean>;
},
$strip,
>;
description: `Apply a config patch to the running ${string} service.`;
kind: "write";
method: "POST";
name: "configApply";
path: "/config/apply";
response: ZodObject<
{
applied: ZodLiteral<true>;
config: ZodObject<{}, $loose>;
warning: ZodOptional<ZodString>;
},
$strip,
>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
description: string;
kind: "read";
method: "GET";
name: "getConfigSchema";
path: "/config/schema";
response: ZodRecord<ZodString, ZodUnknown>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
body: ZodObject<{ paths: ZodArray<ZodString> }, $strip>;
description: string;
kind: "read";
method: "POST";
name: "matchConfig";
path: "/config/match";
response: ZodObject<
{
matches: ZodArray<
ZodObject<
{ rules: ZodArray<ZodString>; watched: ZodBoolean },
$strip,
>,
>;
},
$strip,
>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
body: ZodObject<
{
config: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
testPaths: ZodOptional<ZodArray<ZodString>>;
},
$strip,
>;
description: string;
kind: "read";
method: "POST";
name: "validateConfig";
path: "/config/validate";
response: ZodObject<
{
errors: ZodOptional<
ZodArray<
ZodObject<{ message: ZodString; path: ZodString }, $strip>,
>,
>;
testResults: ZodOptional<
ZodArray<
ZodObject<
{
error: ZodOptional<ZodString>;
matchedRules: ZodArray<ZodString>;
metadata: ZodRecord<ZodString, ZodUnknown>;
path: ZodString;
},
$strip,
>,
>,
>;
valid: ZodBoolean;
warnings: ZodOptional<
ZodArray<
ZodObject<{ message: ZodString; path: ZodString }, $strip>,
>,
>;
},
$strip,
>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
body: ZodObject<
{
filter: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
limit: ZodOptional<ZodNumber>;
offset: ZodOptional<ZodNumber>;
query: ZodString;
},
$strict,
>;
description: string;
kind: "read";
method: "POST";
name: "search";
path: "/search";
response: ZodArray<
ZodObject<
{
id: ZodString;
payload: ZodRecord<ZodString, ZodUnknown>;
score: ZodNumber;
},
$strip,
>,
>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
body: ZodObject<
{
countOnly: ZodOptional<ZodBoolean>;
cursor: ZodOptional<ZodUnion<readonly [ZodString, ZodNumber]>>;
fields: ZodOptional<ZodArray<ZodString>>;
filter: ZodRecord<ZodString, ZodUnknown>;
limit: ZodOptional<ZodNumber>;
},
$strip,
>;
description: string;
kind: "read";
method: "POST";
name: "scan";
path: "/scan";
response: ZodUnion<
readonly [
ZodObject<
{
cursor: ZodUnion<readonly [ZodString, ZodNumber, ZodNull]>;
points: ZodArray<
ZodObject<
{ id: ZodString; payload: ZodRecord<(...), (...)> },
$strip,
>,
>;
},
$strip,
>,
ZodObject<{ count: ZodNumber }, $strip>,
],
>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
description: string;
kind: "read";
method: "GET";
name: "listFacets";
path: "/search/facets";
query: ZodObject<{ rules: ZodOptional<ZodString> }, $strip>;
response: ZodObject<
{
facets: ZodArray<
ZodObject<
{
field: ZodString;
rules: ZodArray<ZodString>;
type: ZodString;
uiHint: ZodString;
values: ZodArray<ZodUnknown>;
},
$strip,
>,
>;
},
$strip,
>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
body: ZodObject<
{
fields: ZodArray<ZodString>;
filter: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
limit: ZodOptional<ZodNumber>;
rules: ZodOptional<ZodArray<ZodString>>;
},
$strict,
>;
description: string;
kind: "read";
method: "POST";
name: "countFacets";
path: "/search/facets/counts";
response: ZodObject<
{
counts: ZodRecord<
ZodString,
ZodUnion<
readonly [
ZodArray<ZodObject<{ count: ...; value: ... }, $strip>>,
ZodObject<{ max: ZodUnion<(...)>; min: ZodUnion<(...)> }, $strip>,
],
>,
>;
},
$strip,
>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
body: ZodObject<
{ path: ZodOptional<ZodString>; source: ZodOptional<ZodString> },
$strip,
>;
description: string;
kind: "read";
method: "POST";
name: "render";
path: "/render";
response: ZodObject<
{
content: ZodString;
metadata: ZodRecord<ZodString, ZodUnknown>;
renderAs: ZodString;
rules: ZodArray<ZodString>;
},
$strip,
>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
body: ZodObject<{ globs: ZodArray<ZodString> }, $strip>;
description: string;
kind: "read";
method: "POST";
name: "walk";
path: "/walk";
response: ZodObject<
{
matchedCount: ZodNumber;
paths: ZodArray<ZodString>;
scannedRoots: ZodArray<ZodString>;
},
$strip,
>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
description: string;
kind: "read";
method: "GET";
name: "listIssues";
path: "/issues";
response: ZodObject<
{
count: ZodNumber;
issues: ZodRecord<
ZodString,
ZodArray<
ZodObject<
{
details: ZodOptional<ZodUnknown>;
message: ZodString;
operation: ZodOptional<ZodString>;
property: ZodOptional<ZodString>;
rule: ZodOptional<ZodString>;
rules: ZodOptional<ZodArray<(...)>>;
timestamp: ZodUnion<readonly [(...), (...)]>;
type: ZodEnum<
{
embedding_error: ...;
extraction_error: ...;
interpolation_error: ...;
match_failed: ...;
no_content: ...;
rule_missing: ...;
source_unavailable: ...;
too_large: ...;
type_collision: ...;
unsupported_content_type: ...;
upsert_error: ...;
},
>;
types: ZodOptional<ZodArray<(...)>>;
},
$strip,
>,
>,
>;
},
$strip,
>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
description: string;
kind: "read";
method: "GET";
name: "getVcsStatus";
path: "/vcs/status";
response: ZodObject<
{
enabled: ZodBoolean;
roots: ZodArray<
ZodObject<
{
breaker: ZodNullable<
ZodObject<
{
consecutiveFailures: ...;
lastError: ...;
pendingCount: ...;
tripped: ...;
trippedAt: ...;
},
$strip,
>,
>;
lastCommit: ZodNullable<
ZodObject<{ hash: ...; message: ...; timestamp: ... }, $strip>,
>;
lastPush: ZodNullable<ZodString>;
path: ZodString;
pushErrors: ZodArray<
ZodObject<{ message: ...; timestamp: ... }, $strip>,
>;
remoteUrl: ZodNullable<ZodString>;
tracked: ZodNumber;
},
$strip,
>,
>;
},
$strip,
>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
description: string;
kind: "read";
method: "GET";
name: "listVcsHistory";
path: "/vcs/history";
query: ZodObject<
{
glob: ZodString;
limit: ZodOptional<ZodString>;
since: ZodOptional<ZodString>;
until: ZodOptional<ZodString>;
},
$strip,
>;
response: ZodArray<
ZodObject<
{
commit: ZodString;
files: ZodArray<ZodString>;
message: ZodString;
timestamp: ZodString;
},
$strip,
>,
>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
contentType: "text/plain";
description: string;
kind: "read";
method: "GET";
name: "showVcsFile";
path: "/vcs/show";
query: ZodObject<{ commit: ZodString; path: ZodString }, $strip>;
response: ZodString;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
contentType: "text/plain";
description: string;
kind: "read";
method: "GET";
name: "diffVcs";
path: "/vcs/diff";
query: ZodObject<
{
commit: ZodString;
commitEnd: ZodOptional<ZodString>;
glob: ZodString;
},
$strip,
>;
response: ZodString;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
description: string;
kind: "read";
method: "GET";
name: "checkVcsExclusion";
path: "/vcs/check-exclusion";
query: ZodObject<{ path: ZodString }, $strip>;
response: ZodObject<
{
excluded: ZodBoolean;
line: ZodOptional<ZodNumber>;
rule: ZodOptional<ZodString>;
source: ZodOptional<ZodString>;
},
$strip,
>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
body: ZodObject<
{
metadata: ZodRecord<ZodString, ZodUnknown>;
path: ZodOptional<ZodString>;
source: ZodOptional<ZodString>;
},
$strip,
>;
description: string;
kind: "write";
method: "POST";
name: "setMetadata";
path: "/metadata";
response: ZodObject<
{ matched_rules: ZodArray<ZodString>; ok: ZodLiteral<true> },
$strip,
>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
body: ZodObject<
{
dryRun: ZodOptional<ZodBoolean>;
path: ZodOptional<ZodUnion<readonly [ZodString, ZodArray<ZodString>]>>;
scope: ZodOptional<
ZodEnum<
{
full: "full";
issues: "issues";
path: "path";
prune: "prune";
rules: "rules";
},
>,
>;
source: ZodOptional<
ZodUnion<readonly [ZodString, ZodArray<ZodString>]>,
>;
},
$strip,
>;
description: string;
kind: "write";
method: "POST";
name: "reindex";
path: "/reindex";
response: ZodObject<
{
plan: ZodOptional<
ZodObject<
{
byRoot: ZodRecord<ZodString, ZodNumber>;
incomplete: ZodOptional<ZodBoolean>;
toDelete: ZodNumber;
toProcess: ZodNumber;
total: ZodNumber;
},
$strip,
>,
>;
scope: ZodEnum<
{
full: "full";
issues: "issues";
path: "path";
prune: "prune";
rules: "rules";
},
>;
status: ZodEnum<{ dry_run: "dry_run"; started: "started" }>;
},
$strip,
>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
body: ZodObject<
{
documents: ZodArray<
ZodObject<{ rule: ZodString; source: ZodString }, $strict>,
>;
},
$strip,
>;
description: string;
kind: "write";
method: "POST";
name: "notifyDocuments";
path: "/documents";
query: ZodObject<
{ wait: ZodOptional<ZodCodec<ZodString, ZodBoolean>> },
$strip,
>;
response: ZodUnion<
readonly [
ZodObject<
{
accepted: ZodArray<ZodString>;
rejected: ZodArray<
ZodObject<
{ error: ZodObject<(...), (...)>; source: ZodString },
$strip,
>,
>;
},
$strip,
>,
ZodObject<
{
results: ZodArray<
ZodObject<
{
chunks: ZodOptional<(...)>;
error: ZodOptional<(...)>;
matched_rules: ZodOptional<(...)>;
source: ZodString;
status: ZodEnum<(...)>;
},
$strip,
>,
>;
},
$strip,
>,
],
>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
body: ZodObject<
{
rules: ZodArray<ZodObject<{ name: ZodString }, $loose>>;
source: ZodString;
},
$strip,
>;
description: string;
kind: "write";
method: "POST";
name: "registerRules";
path: "/rules/register";
response: ZodObject<
{
registered: ZodNumber;
source: ZodString;
totalVirtualRules: ZodNumber;
},
$strip,
>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
body: ZodObject<{ globs: ZodArray<ZodString> }, $strip>;
description: string;
kind: "write";
method: "POST";
name: "reapplyRules";
path: "/rules/reapply";
response: ZodObject<{ matched: ZodNumber; updated: ZodNumber }, $strip>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
body: ZodObject<{}, $strip>;
description: string;
kind: "write";
method: "POST";
name: "rebuildMetadata";
path: "/rebuild-metadata";
response: ZodObject<{ ok: ZodLiteral<true> }, $strip>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
body: ZodObject<
{
filter: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
sources: ZodOptional<ZodArray<ZodString>>;
},
$strict,
>;
description: string;
kind: "destructive";
method: "POST";
name: "deleteDocuments";
path: "/documents/delete";
response: ZodObject<{ deleted: ZodNumber }, $strip>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
body: ZodObject<{ filter: ZodRecord<ZodString, ZodUnknown> }, $strip>;
description: string;
kind: "destructive";
method: "POST";
name: "deletePoints";
path: "/points/delete";
response: ZodObject<{ deleted: ZodNumber }, $strip>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
body: ZodObject<{ source: ZodString }, $strip>;
description: string;
kind: "destructive";
method: "DELETE";
name: "unregisterRules";
path: "/rules/unregister";
response: ZodObject<{ removed: ZodBoolean; source: ZodString }, $strip>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
description: string;
kind: "destructive";
method: "DELETE";
name: "unregisterRulesBySource";
params: ZodObject<{ source: ZodString }, $strip>;
path: "/rules/unregister/:source";
response: ZodObject<{ removed: ZodBoolean; source: ZodString }, $strip>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
body: ZodObject<
{
commit: ZodString;
existingOnly: ZodOptional<ZodBoolean>;
glob: ZodString;
},
$strip,
>;
description: string;
kind: "destructive";
method: "POST";
name: "revertVcs";
path: "/vcs/revert";
response: ZodObject<
{ files: ZodArray<ZodString>; restored: ZodNumber },
$strip,
>;
},
{
auth: { schemes: readonly [{ in: "bearer" }] };
body: ZodObject<
{
confirm: ZodOptional<ZodBoolean>;
glob: ZodString;
remove: ZodOptional<ZodBoolean>;
root: ZodOptional<ZodString>;
},
$strip,
>;
description: string;
kind: "destructive";
method: "POST";
name: "excludeVcsPath";
path: "/vcs/exclude";
response: ZodObject<
{
action: ZodEnum<{ added: "added"; removed: "removed" }>;
file: ZodString;
ok: ZodLiteral<true>;
untracked: ZodNumber;
},
$strip,
>;
},
],
> = ...
The watcher endpoint catalog.