Address OpenAPI PR review feedback

Remove the localhost servers entry, clarify the SSE stream description, point docs readers at /api/openapi.json, add the changelog entry, and update the lockfile metadata.

Author: KonradStanski

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Require explicit invocation of ask_codebase tool in MCP [#995](https://github.com/sourcebot-dev/sourcebot/pull/995)
 - Gate MCP API behind authentication when Ask GitHub is enabled. [#994](https://github.com/sourcebot-dev/sourcebot/pull/994)
+- Added generated OpenAPI documentation for the public search, repo, and file browsing API surface. [#101](https://github.com/sourcebot-dev/sourcebot/issues/101)
 
 ## [4.15.4] - 2026-03-11
 

docs/api-reference/sourcebot-public.openapi.json

@@ -2,15 +2,9 @@
   "openapi": "3.0.3",
   "info": {
     "title": "Sourcebot Public API",
-    "version": "v4.15.2",
+    "version": "v4.15.4",
     "description": "OpenAPI description for the public Sourcebot REST endpoints used for search, repository listing, and file browsing."
   },
-  "servers": [
-    {
-      "url": "http://localhost:3000",
-      "description": "Local development web app"
-    }
-  ],
   "tags": [
     {
       "name": "Search",
@@ -443,7 +437,7 @@
       },
       "PublicStreamSearchSse": {
         "type": "string",
-        "description": "Server-sent event stream. Each data frame contains one JSON object matching PublicStreamedSearchEvent.",
+        "description": "Server-sent event stream. Each data frame contains one JSON object representing either a chunk update, a final summary, or an error.",
         "example": "data: {\"type\":\"chunk\",\"stats\":{\"actualMatchCount\":1}}\n\n"
       },
       "PublicRepository": {

docs/docs/api-reference/overview.mdx

@@ -3,11 +3,11 @@ title: API Reference
 sidebarTitle: API Reference
 ---
 
-Sourcebot exposes a public REST API for code search, repository listing, and file browsing.
+You can fetch the OpenAPI document for your Sourcebot instance from `/api/openapi.json`.
 
-The endpoint reference in this section is generated from the web app's Zod schemas and OpenAPI registry, then rendered by Mintlify from [`api-reference/sourcebot-public.openapi.json`](/api-reference/sourcebot-public.openapi.json).
+This API reference is generated from the web app's Zod schemas and OpenAPI registry. Mintlify renders it from the checked-in spec at [`/api-reference/sourcebot-public.openapi.json`](/api-reference/sourcebot-public.openapi.json).
 
-The first documented surface includes:
+The first documented endpoints include:
 
 - `/api/search`
 - `/api/stream_search`
@@ -17,7 +17,7 @@ The first documented surface includes:
 - `/api/tree`
 - `/api/files`
 
-To refresh the spec after changing those contracts:
+To refresh the spec after you change those contracts:
 
 ```bash
 yarn openapi:generate

packages/web/src/openapi/publicApiDocument.ts

@@ -229,12 +229,6 @@ export function createPublicOpenApiDocument(version: string) {
             version,
             description: 'OpenAPI description for the public Sourcebot REST endpoints used for search, repository listing, and file browsing.',
         },
-        servers: [
-            {
-                url: 'http://localhost:3000',
-                description: 'Local development web app',
-            },
-        ],
         tags: [searchTag, reposTag, filesTag, miscTag],
     });
 

packages/web/src/openapi/publicApiSchemas.ts

@@ -71,6 +71,6 @@ export const publicListReposQuerySchema = z.object({
 export const publicListReposResponseSchema = z.array(publicRepositorySchema).openapi('PublicListReposResponse');
 
 export const publicStreamSearchSseSchema = z.string().openapi('PublicStreamSearchSse', {
-    description: 'Server-sent event stream. Each data frame contains one JSON object matching PublicStreamedSearchEvent.',
+    description: 'Server-sent event stream. Each data frame contains one JSON object representing either a chunk update, a final summary, or an error.',
     example: 'data: {"type":"chunk","stats":{"actualMatchCount":1}}\n\n',
 });

yarn.lock

@@ -8699,7 +8699,6 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@sourcebot/backend@workspace:packages/backend"
   dependencies:
-    "@asteasolutions/zod-to-openapi": "npm:7.3.4"
     "@coderabbitai/bitbucket": "npm:^1.1.3"
     "@gitbeaker/rest": "npm:^40.5.1"
     "@octokit/app": "npm:^16.1.1"