Skip to content

The open-source agent harness - the runtime layer that turns an LLM into a working agent.

Exclude all internal routes from docs (#776)

Chirag Jain847c14363c84
diff --git a/.github/fern/openapi/openapi.json b/.github/fern/openapi/openapi.json
index e9d988bef..91b9285c1 100644
--- a/.github/fern/openapi/openapi.json
+++ b/.github/fern/openapi/openapi.json
@@ -5663,7 +5663,7 @@
"info": {
"description": "HTTP API for the TrueForge agent server (`/api/v1`). Interactive docs are served at `/api/v1/docs` (OpenAPI JSON at `/api/v1/openapi.json`).\n\n**Authentication:** Standalone auth accepts requests without credentials — middleware stamps a local default user. When OIDC or TrueFoundry auth is configured, protected routes require a valid cookie or `Authorization: Bearer` token. There is no built-in API-key scheme; pass custom headers only if your reverse proxy or IdP layer requires them.\n\nCovers DB-backed sessions, the agent registry, settings catalogs, and model/MCP/skill/sandbox providers.",
"title": "TrueForge API",
- "version": "0.2.0-rc.11"
+ "version": "0.2.0-rc.12"
},
"openapi": "3.1.0",
"paths": {
@@ -5706,6 +5706,7 @@
"tags": [
"Internal"
],
+ "x-excluded": true,
"x-fern-ignore": true
}
},
@@ -5761,6 +5762,7 @@
"tags": [
"Internal"
],
+ "x-excluded": true,
"x-fern-ignore": true
}
},
@@ -5823,6 +5825,7 @@
"tags": [
"Internal"
],
+ "x-excluded": true,
"x-fern-ignore": true
}
},
@@ -5875,6 +5878,7 @@
"tags": [
"Internal"
],
+ "x-excluded": true,
"x-fern-sdk-group-name": [
"internal"
],
@@ -5900,6 +5904,7 @@
"tags": [
"Internal"
],
+ "x-excluded": true,
"x-fern-sdk-group-name": [
"internal",
"metrics"
@@ -5981,6 +5986,7 @@
"tags": [
"Internal"
],
+ "x-excluded": true,
"x-fern-sdk-group-name": [
"internal",
"metrics"
@@ -6053,6 +6059,7 @@
"tags": [
"Internal"
],
+ "x-excluded": true,
"x-fern-sdk-group-name": [
"internal",
"metrics"
@@ -6112,6 +6119,7 @@
"tags": [
"Internal"
],
+ "x-excluded": true,
"x-fern-sdk-group-name": [
"internal",
"schedules"
@@ -6198,6 +6206,7 @@
"tags": [
"Internal"
],
+ "x-excluded": true,
"x-fern-sdk-group-name": [
"internal",
"sessions"
diff --git a/docs/openapi.json b/docs/openapi.json
index e9d988bef..91b9285c1 100644
--- a/docs/openapi.json
+++ b/docs/openapi.json
@@ -5663,7 +5663,7 @@
"info": {
"description": "HTTP API for the TrueForge agent server (`/api/v1`). Interactive docs are served at `/api/v1/docs` (OpenAPI JSON at `/api/v1/openapi.json`).\n\n**Authentication:** Standalone auth accepts requests without credentials — middleware stamps a local default user. When OIDC or TrueFoundry auth is configured, protected routes require a valid cookie or `Authorization: Bearer` token. There is no built-in API-key scheme; pass custom headers only if your reverse proxy or IdP layer requires them.\n\nCovers DB-backed sessions, the agent registry, settings catalogs, and model/MCP/skill/sandbox providers.",
"title": "TrueForge API",
- "version": "0.2.0-rc.11"
+ "version": "0.2.0-rc.12"
},
"openapi": "3.1.0",
"paths": {
@@ -5706,6 +5706,7 @@
"tags": [
"Internal"
],
+ "x-excluded": true,
"x-fern-ignore": true
}
},
@@ -5761,6 +5762,7 @@
"tags": [
"Internal"
],
+ "x-excluded": true,
"x-fern-ignore": true
}
},
@@ -5823,6 +5825,7 @@
"tags": [
"Internal"
],
+ "x-excluded": true,
"x-fern-ignore": true
}
},
@@ -5875,6 +5878,7 @@
"tags": [
"Internal"
],
+ "x-excluded": true,
"x-fern-sdk-group-name": [
"internal"
],
@@ -5900,6 +5904,7 @@
"tags": [
"Internal"
],
+ "x-excluded": true,
"x-fern-sdk-group-name": [
"internal",
"metrics"
@@ -5981,6 +5986,7 @@
"tags": [
"Internal"
],
+ "x-excluded": true,
"x-fern-sdk-group-name": [
"internal",
"metrics"
@@ -6053,6 +6059,7 @@
"tags": [
"Internal"
],
+ "x-excluded": true,
"x-fern-sdk-group-name": [
"internal",
"metrics"
@@ -6112,6 +6119,7 @@
"tags": [
"Internal"
],
+ "x-excluded": true,
"x-fern-sdk-group-name": [
"internal",
"schedules"
@@ -6198,6 +6206,7 @@
"tags": [
"Internal"
],
+ "x-excluded": true,
"x-fern-sdk-group-name": [
"internal",
"sessions"
diff --git a/packages/trueforge/src/routes/agentImportRoutes.ts b/packages/trueforge/src/routes/agentImportRoutes.ts
index 0fd30b271..a560cd138 100644
--- a/packages/trueforge/src/routes/agentImportRoutes.ts
+++ b/packages/trueforge/src/routes/agentImportRoutes.ts
@@ -20,6 +20,7 @@ export const importAgentsRoute = createRoute({
summary: 'Import agents in bulk (create)',
description: 'Ops/backfill only. Per-item created | exists | failed.',
'x-fern-ignore': true,
+ 'x-excluded': true,
request: {
body: {
content: { 'application/json': { schema: ImportAgentsRequestSchema } },
@@ -46,6 +47,7 @@ export const importSessionRoute = createRoute({
description:
'Ops/backfill only. Named sessions link agent_name to a local agent when present; otherwise a dummy agent_id. Drafts use agent_spec (SF name/id stashed in metadata when both present). 409 if session_id exists.',
'x-fern-ignore': true,
+ 'x-excluded': true,
request: {
body: {
content: { 'application/json': { schema: ImportSessionRequestSchema } },
@@ -79,6 +81,7 @@ export const getImportSessionsCheckpointRoute = createRoute({
summary: 'Session import checkpoint',
description: 'Min created_at among imported sessions for one tenant (metadata.imported=true).',
'x-fern-ignore': true,
+ 'x-excluded': true,
request: {
query: ImportSessionsCheckpointQuerySchema,
},
diff --git a/packages/trueforge/src/routes/permissionRoutes.ts b/packages/trueforge/src/routes/permissionRoutes.ts
index fe29561dc..44031573a 100644
--- a/packages/trueforge/src/routes/permissionRoutes.ts
+++ b/packages/trueforge/src/routes/permissionRoutes.ts
@@ -14,6 +14,7 @@ export const listPermissionsRoute = createRoute({
description: 'Return granted actions for the requested resources.',
'x-fern-sdk-group-name': ['internal'],
'x-fern-sdk-method-name': 'list_permissions',
+ 'x-excluded': true,
request: {
body: {
content: { 'application/json': { schema: ListPermissionsRequestSchema } },
diff --git a/packages/trueforge/src/routes/scheduleRoutes.ts b/packages/trueforge/src/routes/scheduleRoutes.ts
index ca4b4b9a6..acd36e43f 100644
--- a/packages/trueforge/src/routes/scheduleRoutes.ts
+++ b/packages/trueforge/src/routes/scheduleRoutes.ts
@@ -179,6 +179,7 @@ export const executeScheduleRunRoute = createRoute({
description: 'Execute a persisted schedule run using its saved schedule and agent.',
'x-fern-sdk-group-name': ['internal', 'schedules'],
'x-fern-sdk-method-name': 'execute_run',
+ 'x-excluded': true,
request: {
body: {
content: { 'application/json': { schema: ExecuteScheduleRunRequestSchema } },
diff --git a/packages/trueforge/src/routes/sessionMetricsRoutes.ts b/packages/trueforge/src/routes/sessionMetricsRoutes.ts
index b8a162121..b7dc1ffd5 100644
--- a/packages/trueforge/src/routes/sessionMetricsRoutes.ts
+++ b/packages/trueforge/src/routes/sessionMetricsRoutes.ts
@@ -21,6 +21,7 @@ export const getSessionMetricsMetersRoute = createRoute({
description: "Aggregate the caller's session meters for a named agent over an inclusive creation-time window.",
'x-fern-sdk-group-name': ['internal', 'metrics'],
'x-fern-sdk-method-name': 'get_meters',
+ 'x-excluded': true,
request: {
query: GetSessionMetricsRequestQuerySchema,
},
@@ -44,6 +45,7 @@ export const getSessionMetricsChartsRoute = createRoute({
description: 'List available session metric charts.',
'x-fern-sdk-group-name': ['internal', 'metrics'],
'x-fern-sdk-method-name': 'list_charts',
+ 'x-excluded': true,
responses: {
200: {
content: { 'application/json': { schema: GetSessionMetricsChartResponseSchema } },
@@ -61,6 +63,7 @@ export const getSessionMetricsChartsDataRoute = createRoute({
"Return one chart for the caller's sessions on a named agent over an inclusive creation-time window. Uses hourly buckets for windows up to 24 hours and daily UTC buckets otherwise.",
'x-fern-sdk-group-name': ['internal', 'metrics'],
'x-fern-sdk-method-name': 'get_chart_data',
+ 'x-excluded': true,
request: {
query: GetSessionMetricsChartDataRequestQuerySchema,
},
diff --git a/packages/trueforge/src/routes/sessionRoutes.ts b/packages/trueforge/src/routes/sessionRoutes.ts
index 2a8636eae..39afff87a 100644
--- a/packages/trueforge/src/routes/sessionRoutes.ts
+++ b/packages/trueforge/src/routes/sessionRoutes.ts
@@ -71,6 +71,7 @@ export const getOrCreateSessionByExternalIdRoute = createRoute({
description: 'Idempotent get-or-create: returns the existing session for this `external_id`, or creates one',
'x-fern-sdk-group-name': ['internal', 'sessions'],
'x-fern-sdk-method-name': 'get_or_create_by_external_id',
+ 'x-excluded': true,
request: {
body: {
content: { 'application/json': { schema: GetOrCreateSessionByExternalIdRequestSchema } },
diff --git a/python/trueforge_sdk/.fern/metadata.json b/python/trueforge_sdk/.fern/metadata.json
index 0c193c627..952f21eff 100644
--- a/python/trueforge_sdk/.fern/metadata.json
+++ b/python/trueforge_sdk/.fern/metadata.json
@@ -21,7 +21,7 @@
},
"pyproject_python_version": ">=3.10"
},
- "originGitCommit": "fd1bf7fedb0663f5a5cda4f5842984b7a60bf933",
+ "originGitCommit": "32a0e5caf6bb938fd95c2325789d6b58977dabe4",
"originGitCommitIsDirty": true,
"invokedBy": "ci",
"requestedVersion": "0.2.0-rc.8",