Skip to content

Add OpenAPI docs for Sourcebot public API #996

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brendan-kellam merged 6 commits into from
Mar 12, 2026
+1,605 −51
Merged

Add OpenAPI docs for Sourcebot public API #996

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
17a49a9
Add OpenAPI docs for Sourcebot public API
KonradStanski Mar 12, 2026
16a5ca0
Address OpenAPI PR review feedback
KonradStanski Mar 12, 2026
1937304
Merge branch 'main' into konrad/public-openapi
brendan-kellam Mar 12, 2026
30cf3a5
update release flow to commit docs changes on version change
brendan-kellam Mar 12, 2026
5e16c10
feedback
brendan-kellam Mar 12, 2026
165ed98
feedback
brendan-kellam Mar 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion .github/workflows/release-prod.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,14 +126,25 @@ jobs:
echo "Updated version.ts with version v$VERSION"
cat packages/shared/src/version.ts

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20.x'

- name: Install dependencies
run: yarn install --frozen-lockfile

- name: Generate OpenAPI docs
run: yarn openapi:generate

- name: Configure git
run: |
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"

- name: Commit changes
run: |
git add CHANGELOG.md packages/shared/src/version.ts
git add CHANGELOG.md packages/shared/src/version.ts docs/api-reference/sourcebot-public.openapi.json
git commit -m "[skip ci] Release v$VERSION"

- name: Push to temporary branch
Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,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

Expand Down
3 changes: 3 additions & 0 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,9 @@ RUN chown -R sourcebot:sourcebot /app
# Copy zoekt proto files (needed for gRPC client at runtime)
COPY --chown=sourcebot:sourcebot vendor/zoekt/grpc/protos /app/vendor/zoekt/grpc/protos

# Copy OpenAPI docs
COPY --chown=sourcebot:sourcebot docs/api-reference/sourcebot-public.openapi.json /app/docs/api-reference/sourcebot-public.openapi.json

# Copy all of the things
COPY --chown=sourcebot:sourcebot --from=web-builder /app/packages/web/public ./packages/web/public
COPY --chown=sourcebot:sourcebot --from=web-builder /app/packages/web/.next/standalone ./
Expand Down
Loading
Loading