@contractspec/bundle.library 3.9.4 → 3.9.5

package/src/components/docs/generated/docs-index.platform-agent.json

@@ -1,202 +1,202 @@
 [
-  {
-    "id": "platform.agent/agent.approval.requested",
-    "title": "agent.approval.requested",
-    "summary": "Emitted when an approval is required for an agent action.\n- **Type**: event (event)\n- **Version**: 1.0.0\n- **Tags**: approval\n- **File**: `packages/libs/contracts-spec/src/agent/events/agentApprovalRequested.event.ts`",
-    "route": "/docs/reference/platform.agent/agent.approval.requested",
-    "source": "generated",
-    "contentPath": "platform.agent/agent.approval.requested.md"
-  },
-  {
-    "id": "platform.agent/agent.approvals",
-    "title": "agent.approvals",
-    "summary": "Approve or reject an agent step or run.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Tags**: approval\n- **File**: `packages/libs/contracts-spec/src/agent/commands/agentApprovals.command.ts`\nProvide governed human-in-the-loop control for risky steps.",
-    "route": "/docs/reference/platform.agent/agent.approvals",
-    "source": "generated",
-    "contentPath": "platform.agent/agent.approvals.md"
-  },
-  {
-    "id": "platform.agent/agent.artifacts",
-    "title": "agent.artifacts",
-    "summary": "List artifacts produced by an agent run.\n- **Type**: operation (query)\n- **Version**: 1.0.0\n- **Tags**: artifacts\n- **File**: `packages/libs/contracts-spec/src/agent/queries/agentArtifacts.query.ts`\nProvide traceable outputs for audits and UI surfaces.",
-    "route": "/docs/reference/platform.agent/agent.artifacts",
-    "source": "generated",
-    "contentPath": "platform.agent/agent.artifacts.md"
-  },
-  {
-    "id": "platform.agent/agent.cancel",
-    "title": "agent.cancel",
-    "summary": "Cancel an in-flight agent run.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Tags**: run, cancel\n- **File**: `packages/libs/contracts-spec/src/agent/commands/agentCancel.command.ts`\nProvide safe operator control to stop background agents.",
-    "route": "/docs/reference/platform.agent/agent.cancel",
-    "source": "generated",
-    "contentPath": "platform.agent/agent.cancel.md"
-  },
-  {
-    "id": "platform.agent/agent.execution",
-    "title": "agent.execution",
-    "summary": "Background agent execution, approvals, and artifacts.\n- **Type**: capability (capability)\n- **Version**: 1.0.0\n- **Tags**: execution\n- **File**: `packages/libs/contracts-spec/src/agent/capabilities/agentExecution.capability.ts`",
-    "route": "/docs/reference/platform.agent/agent.execution",
-    "source": "generated",
-    "contentPath": "platform.agent/agent.execution.md"
-  },
-  {
-    "id": "platform.agent/agent.run",
-    "title": "agent.run",
-    "summary": "Submit a background agent run with a context snapshot.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Tags**: run\n- **File**: `packages/libs/contracts-spec/src/agent/commands/agentRun.command.ts`",
-    "route": "/docs/reference/platform.agent/agent.run",
-    "source": "generated",
-    "contentPath": "platform.agent/agent.run.md"
-  },
-  {
-    "id": "platform.agent/agent.run.audit",
-    "title": "agent.run.audit",
-    "summary": "Audit layout for agent runs and artifacts.\n- **Type**: presentation (presentation)\n- **Version**: 1.0.0\n- **Tags**: audit\n- **File**: `packages/libs/contracts-spec/src/agent/presentations/agentRunAudit.presentation.ts`",
-    "route": "/docs/reference/platform.agent/agent.run.audit",
-    "source": "generated",
-    "contentPath": "platform.agent/agent.run.audit.md"
-  },
-  {
-    "id": "platform.agent/agent.run.completed",
-    "title": "agent.run.completed",
-    "summary": "Emitted when an agent run completes successfully.\n- **Type**: event (event)\n- **Version**: 1.0.0\n- **Tags**: run\n- **File**: `packages/libs/contracts-spec/src/agent/events/agentRunCompleted.event.ts`\n```typescript",
-    "route": "/docs/reference/platform.agent/agent.run.completed",
-    "source": "generated",
-    "contentPath": "platform.agent/agent.run.completed.md"
-  },
-  {
-    "id": "platform.agent/agent.run.failed",
-    "title": "agent.run.failed",
-    "summary": "Emitted when an agent run fails.\n- **Type**: event (event)\n- **Version**: 1.0.0\n- **Tags**: run\n- **File**: `packages/libs/contracts-spec/src/agent/events/agentRunFailed.event.ts`\n```typescript\nimport { ScalarTypeEnum, SchemaModel } from '@contractspec/lib.schema';",
-    "route": "/docs/reference/platform.agent/agent.run.failed",
-    "source": "generated",
-    "contentPath": "platform.agent/agent.run.failed.md"
-  },
-  {
-    "id": "platform.agent/agent.run.form",
-    "title": "agent.run.form",
-    "summary": "Form to launch a background agent run.\n- **Type**: form (form)\n- **Version**: 1.0.0\n- **Tags**: run\n- **File**: `packages/libs/contracts-spec/src/agent/forms/agentRun.form.ts`\n```typescript\nimport { ScalarTypeEnum, SchemaModel } from '@contractspec/lib.schema';",
-    "route": "/docs/reference/platform.agent/agent.run.form",
-    "source": "generated",
-    "contentPath": "platform.agent/agent.run.form.md"
-  },
-  {
-    "id": "platform.agent/agent.run.started",
-    "title": "agent.run.started",
-    "summary": "Emitted when an agent run starts executing.\n- **Type**: event (event)\n- **Version**: 1.0.0\n- **Tags**: run\n- **File**: `packages/libs/contracts-spec/src/agent/events/agentRunStarted.event.ts`\n```typescript\nimport { ScalarTypeEnum, SchemaModel } from '@contractspec/lib.schema';",
-    "route": "/docs/reference/platform.agent/agent.run.started",
-    "source": "generated",
-    "contentPath": "platform.agent/agent.run.started.md"
-  },
-  {
-    "id": "platform.agent/agent.status",
-    "title": "agent.status",
-    "summary": "Get status for agent runs.\n- **Type**: operation (query)\n- **Version**: 1.0.0\n- **Tags**: status\n- **File**: `packages/libs/contracts-spec/src/agent/queries/agentStatus.query.ts`\nProvide status and progress visibility for background agents.",
-    "route": "/docs/reference/platform.agent/agent.status",
-    "source": "generated",
-    "contentPath": "platform.agent/agent.status.md"
-  },
-  {
-    "id": "platform.agent/docs.tech.agent.approval.requested",
-    "title": "agent.approval.requested",
-    "summary": "Emitted when an approval gate is triggered.",
-    "route": "/docs/reference/platform.agent/docs.tech.agent.approval.requested",
-    "source": "generated",
-    "contentPath": "platform.agent/docs.tech.agent.approval.requested.md"
-  },
-  {
-    "id": "platform.agent/docs.tech.agent.approvals",
-    "title": "agent.approvals",
-    "summary": "Approve or reject a pending agent action.",
-    "route": "/docs/reference/platform.agent/docs.tech.agent.approvals",
-    "source": "generated",
-    "contentPath": "platform.agent/docs.tech.agent.approvals.md"
-  },
-  {
-    "id": "platform.agent/docs.tech.agent.artifacts",
-    "title": "agent.artifacts",
-    "summary": "Lists files, diffs, and outputs produced during agent execution.",
-    "route": "/docs/reference/platform.agent/docs.tech.agent.artifacts",
-    "source": "generated",
-    "contentPath": "platform.agent/docs.tech.agent.artifacts.md"
-  },
-  {
-    "id": "platform.agent/docs.tech.agent.cancel",
-    "title": "agent.cancel",
-    "summary": "Stops an active agent run and records cancellation metadata.",
-    "route": "/docs/reference/platform.agent/docs.tech.agent.cancel",
-    "source": "generated",
-    "contentPath": "platform.agent/docs.tech.agent.cancel.md"
-  },
-  {
-    "id": "platform.agent/docs.tech.agent.execution",
-    "title": "Agent execution",
-    "summary": "Defines the core operations, events, and UI surfaces for background agent runs with auditability and approvals.",
-    "route": "/docs/reference/platform.agent/docs.tech.agent.execution",
-    "source": "generated",
-    "contentPath": "platform.agent/docs.tech.agent.execution.md"
-  },
-  {
-    "id": "platform.agent/docs.tech.agent.run",
-    "title": "agent.run",
-    "summary": "Creates a new agent run with a context snapshot and execution metadata.",
-    "route": "/docs/reference/platform.agent/docs.tech.agent.run",
-    "source": "generated",
-    "contentPath": "platform.agent/docs.tech.agent.run.md"
-  },
-  {
-    "id": "platform.agent/docs.tech.agent.run.audit",
-    "title": "agent.run.audit",
-    "summary": "Presentation surface used to inspect run provenance, tools, approvals, and outputs.",
-    "route": "/docs/reference/platform.agent/docs.tech.agent.run.audit",
-    "source": "generated",
-    "contentPath": "platform.agent/docs.tech.agent.run.audit.md"
-  },
-  {
-    "id": "platform.agent/docs.tech.agent.run.completed",
-    "title": "agent.run.completed",
-    "summary": "Emitted when a run completes successfully.",
-    "route": "/docs/reference/platform.agent/docs.tech.agent.run.completed",
-    "source": "generated",
-    "contentPath": "platform.agent/docs.tech.agent.run.completed.md"
-  },
-  {
-    "id": "platform.agent/docs.tech.agent.run.failed",
-    "title": "agent.run.failed",
-    "summary": "Emitted when a run terminates with failure.",
-    "route": "/docs/reference/platform.agent/docs.tech.agent.run.failed",
-    "source": "generated",
-    "contentPath": "platform.agent/docs.tech.agent.run.failed.md"
-  },
-  {
-    "id": "platform.agent/docs.tech.agent.run.form",
-    "title": "agent.run.form",
-    "summary": "Form surface used by Studio to submit agent runs.",
-    "route": "/docs/reference/platform.agent/docs.tech.agent.run.form",
-    "source": "generated",
-    "contentPath": "platform.agent/docs.tech.agent.run.form.md"
-  },
-  {
-    "id": "platform.agent/docs.tech.agent.run.started",
-    "title": "agent.run.started",
-    "summary": "Emitted when an agent run begins execution.",
-    "route": "/docs/reference/platform.agent/docs.tech.agent.run.started",
-    "source": "generated",
-    "contentPath": "platform.agent/docs.tech.agent.run.started.md"
-  },
-  {
-    "id": "platform.agent/docs.tech.agent.status",
-    "title": "agent.status",
-    "summary": "Returns status summaries for one or many agent runs.",
-    "route": "/docs/reference/platform.agent/docs.tech.agent.status",
-    "source": "generated",
-    "contentPath": "platform.agent/docs.tech.agent.status.md"
-  },
-  {
-    "id": "platform.agent/platform.agent",
-    "title": "platform.agent",
-    "summary": "Run, cancel, and approve AI agent executions with full audit trail\n- **Type**: feature\n- **Version**: 1.0.0\n- **Tags**: agent, execution\n- **File**: `packages/libs/contracts-spec/src/agent/agent.feature.ts`",
-    "route": "/docs/reference/platform.agent/platform.agent",
-    "source": "generated",
-    "contentPath": "platform.agent/platform.agent.md"
-  }
-]
+	{
+		"id": "platform.agent/agent.approval.requested",
+		"title": "agent.approval.requested",
+		"summary": "Emitted when an approval is required for an agent action.\n- **Type**: event (event)\n- **Version**: 1.0.0\n- **Tags**: approval\n- **File**: `packages/libs/contracts-spec/src/agent/events/agentApprovalRequested.event.ts`",
+		"route": "/docs/reference/platform.agent/agent.approval.requested",
+		"source": "generated",
+		"contentPath": "platform.agent/agent.approval.requested.md"
+	},
+	{
+		"id": "platform.agent/agent.approvals",
+		"title": "agent.approvals",
+		"summary": "Approve or reject an agent step or run.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Tags**: approval\n- **File**: `packages/libs/contracts-spec/src/agent/commands/agentApprovals.command.ts`\nProvide governed human-in-the-loop control for risky steps.",
+		"route": "/docs/reference/platform.agent/agent.approvals",
+		"source": "generated",
+		"contentPath": "platform.agent/agent.approvals.md"
+	},
+	{
+		"id": "platform.agent/agent.artifacts",
+		"title": "agent.artifacts",
+		"summary": "List artifacts produced by an agent run.\n- **Type**: operation (query)\n- **Version**: 1.0.0\n- **Tags**: artifacts\n- **File**: `packages/libs/contracts-spec/src/agent/queries/agentArtifacts.query.ts`\nProvide traceable outputs for audits and UI surfaces.",
+		"route": "/docs/reference/platform.agent/agent.artifacts",
+		"source": "generated",
+		"contentPath": "platform.agent/agent.artifacts.md"
+	},
+	{
+		"id": "platform.agent/agent.cancel",
+		"title": "agent.cancel",
+		"summary": "Cancel an in-flight agent run.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Tags**: run, cancel\n- **File**: `packages/libs/contracts-spec/src/agent/commands/agentCancel.command.ts`\nProvide safe operator control to stop background agents.",
+		"route": "/docs/reference/platform.agent/agent.cancel",
+		"source": "generated",
+		"contentPath": "platform.agent/agent.cancel.md"
+	},
+	{
+		"id": "platform.agent/agent.execution",
+		"title": "agent.execution",
+		"summary": "Background agent execution, approvals, and artifacts.\n- **Type**: capability (capability)\n- **Version**: 1.0.0\n- **Tags**: execution\n- **File**: `packages/libs/contracts-spec/src/agent/capabilities/agentExecution.capability.ts`",
+		"route": "/docs/reference/platform.agent/agent.execution",
+		"source": "generated",
+		"contentPath": "platform.agent/agent.execution.md"
+	},
+	{
+		"id": "platform.agent/agent.run",
+		"title": "agent.run",
+		"summary": "Submit a background agent run with a context snapshot.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Tags**: run\n- **File**: `packages/libs/contracts-spec/src/agent/commands/agentRun.command.ts`",
+		"route": "/docs/reference/platform.agent/agent.run",
+		"source": "generated",
+		"contentPath": "platform.agent/agent.run.md"
+	},
+	{
+		"id": "platform.agent/agent.run.audit",
+		"title": "agent.run.audit",
+		"summary": "Audit layout for agent runs and artifacts.\n- **Type**: presentation (presentation)\n- **Version**: 1.0.0\n- **Tags**: audit\n- **File**: `packages/libs/contracts-spec/src/agent/presentations/agentRunAudit.presentation.ts`",
+		"route": "/docs/reference/platform.agent/agent.run.audit",
+		"source": "generated",
+		"contentPath": "platform.agent/agent.run.audit.md"
+	},
+	{
+		"id": "platform.agent/agent.run.completed",
+		"title": "agent.run.completed",
+		"summary": "Emitted when an agent run completes successfully.\n- **Type**: event (event)\n- **Version**: 1.0.0\n- **Tags**: run\n- **File**: `packages/libs/contracts-spec/src/agent/events/agentRunCompleted.event.ts`\n```typescript",
+		"route": "/docs/reference/platform.agent/agent.run.completed",
+		"source": "generated",
+		"contentPath": "platform.agent/agent.run.completed.md"
+	},
+	{
+		"id": "platform.agent/agent.run.failed",
+		"title": "agent.run.failed",
+		"summary": "Emitted when an agent run fails.\n- **Type**: event (event)\n- **Version**: 1.0.0\n- **Tags**: run\n- **File**: `packages/libs/contracts-spec/src/agent/events/agentRunFailed.event.ts`\n```typescript\nimport { ScalarTypeEnum, SchemaModel } from '@contractspec/lib.schema';",
+		"route": "/docs/reference/platform.agent/agent.run.failed",
+		"source": "generated",
+		"contentPath": "platform.agent/agent.run.failed.md"
+	},
+	{
+		"id": "platform.agent/agent.run.form",
+		"title": "agent.run.form",
+		"summary": "Form to launch a background agent run.\n- **Type**: form (form)\n- **Version**: 1.0.0\n- **Tags**: run\n- **File**: `packages/libs/contracts-spec/src/agent/forms/agentRun.form.ts`\n```typescript\nimport { ScalarTypeEnum, SchemaModel } from '@contractspec/lib.schema';",
+		"route": "/docs/reference/platform.agent/agent.run.form",
+		"source": "generated",
+		"contentPath": "platform.agent/agent.run.form.md"
+	},
+	{
+		"id": "platform.agent/agent.run.started",
+		"title": "agent.run.started",
+		"summary": "Emitted when an agent run starts executing.\n- **Type**: event (event)\n- **Version**: 1.0.0\n- **Tags**: run\n- **File**: `packages/libs/contracts-spec/src/agent/events/agentRunStarted.event.ts`\n```typescript\nimport { ScalarTypeEnum, SchemaModel } from '@contractspec/lib.schema';",
+		"route": "/docs/reference/platform.agent/agent.run.started",
+		"source": "generated",
+		"contentPath": "platform.agent/agent.run.started.md"
+	},
+	{
+		"id": "platform.agent/agent.status",
+		"title": "agent.status",
+		"summary": "Get status for agent runs.\n- **Type**: operation (query)\n- **Version**: 1.0.0\n- **Tags**: status\n- **File**: `packages/libs/contracts-spec/src/agent/queries/agentStatus.query.ts`\nProvide status and progress visibility for background agents.",
+		"route": "/docs/reference/platform.agent/agent.status",
+		"source": "generated",
+		"contentPath": "platform.agent/agent.status.md"
+	},
+	{
+		"id": "platform.agent/docs.tech.agent.approval.requested",
+		"title": "agent.approval.requested",
+		"summary": "Emitted when an approval gate is triggered.",
+		"route": "/docs/reference/platform.agent/docs.tech.agent.approval.requested",
+		"source": "generated",
+		"contentPath": "platform.agent/docs.tech.agent.approval.requested.md"
+	},
+	{
+		"id": "platform.agent/docs.tech.agent.approvals",
+		"title": "agent.approvals",
+		"summary": "Approve or reject a pending agent action.",
+		"route": "/docs/reference/platform.agent/docs.tech.agent.approvals",
+		"source": "generated",
+		"contentPath": "platform.agent/docs.tech.agent.approvals.md"
+	},
+	{
+		"id": "platform.agent/docs.tech.agent.artifacts",
+		"title": "agent.artifacts",
+		"summary": "Lists files, diffs, and outputs produced during agent execution.",
+		"route": "/docs/reference/platform.agent/docs.tech.agent.artifacts",
+		"source": "generated",
+		"contentPath": "platform.agent/docs.tech.agent.artifacts.md"
+	},
+	{
+		"id": "platform.agent/docs.tech.agent.cancel",
+		"title": "agent.cancel",
+		"summary": "Stops an active agent run and records cancellation metadata.",
+		"route": "/docs/reference/platform.agent/docs.tech.agent.cancel",
+		"source": "generated",
+		"contentPath": "platform.agent/docs.tech.agent.cancel.md"
+	},
+	{
+		"id": "platform.agent/docs.tech.agent.execution",
+		"title": "Agent execution",
+		"summary": "Defines the core operations, events, and UI surfaces for background agent runs with auditability and approvals.",
+		"route": "/docs/reference/platform.agent/docs.tech.agent.execution",
+		"source": "generated",
+		"contentPath": "platform.agent/docs.tech.agent.execution.md"
+	},
+	{
+		"id": "platform.agent/docs.tech.agent.run",
+		"title": "agent.run",
+		"summary": "Creates a new agent run with a context snapshot and execution metadata.",
+		"route": "/docs/reference/platform.agent/docs.tech.agent.run",
+		"source": "generated",
+		"contentPath": "platform.agent/docs.tech.agent.run.md"
+	},
+	{
+		"id": "platform.agent/docs.tech.agent.run.audit",
+		"title": "agent.run.audit",
+		"summary": "Presentation surface used to inspect run provenance, tools, approvals, and outputs.",
+		"route": "/docs/reference/platform.agent/docs.tech.agent.run.audit",
+		"source": "generated",
+		"contentPath": "platform.agent/docs.tech.agent.run.audit.md"
+	},
+	{
+		"id": "platform.agent/docs.tech.agent.run.completed",
+		"title": "agent.run.completed",
+		"summary": "Emitted when a run completes successfully.",
+		"route": "/docs/reference/platform.agent/docs.tech.agent.run.completed",
+		"source": "generated",
+		"contentPath": "platform.agent/docs.tech.agent.run.completed.md"
+	},
+	{
+		"id": "platform.agent/docs.tech.agent.run.failed",
+		"title": "agent.run.failed",
+		"summary": "Emitted when a run terminates with failure.",
+		"route": "/docs/reference/platform.agent/docs.tech.agent.run.failed",
+		"source": "generated",
+		"contentPath": "platform.agent/docs.tech.agent.run.failed.md"
+	},
+	{
+		"id": "platform.agent/docs.tech.agent.run.form",
+		"title": "agent.run.form",
+		"summary": "Form surface used by Studio to submit agent runs.",
+		"route": "/docs/reference/platform.agent/docs.tech.agent.run.form",
+		"source": "generated",
+		"contentPath": "platform.agent/docs.tech.agent.run.form.md"
+	},
+	{
+		"id": "platform.agent/docs.tech.agent.run.started",
+		"title": "agent.run.started",
+		"summary": "Emitted when an agent run begins execution.",
+		"route": "/docs/reference/platform.agent/docs.tech.agent.run.started",
+		"source": "generated",
+		"contentPath": "platform.agent/docs.tech.agent.run.started.md"
+	},
+	{
+		"id": "platform.agent/docs.tech.agent.status",
+		"title": "agent.status",
+		"summary": "Returns status summaries for one or many agent runs.",
+		"route": "/docs/reference/platform.agent/docs.tech.agent.status",
+		"source": "generated",
+		"contentPath": "platform.agent/docs.tech.agent.status.md"
+	},
+	{
+		"id": "platform.agent/platform.agent",
+		"title": "platform.agent",
+		"summary": "Run, cancel, and approve AI agent executions with full audit trail\n- **Type**: feature\n- **Version**: 1.0.0\n- **Tags**: agent, execution\n- **File**: `packages/libs/contracts-spec/src/agent/agent.feature.ts`",
+		"route": "/docs/reference/platform.agent/platform.agent",
+		"source": "generated",
+		"contentPath": "platform.agent/platform.agent.md"
+	}
+]