Skip to content

docs(api): use public API endpoint prefix - #680

Open
vrmiguel wants to merge 3 commits into
mainfrom
tembo/fix-public-api-endpoints
Open

docs(api): use public API endpoint prefix#680
vrmiguel wants to merge 3 commits into
mainfrom
tembo/fix-public-api-endpoints

Conversation

@vrmiguel

@vrmiguel vrmiguel commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

summary

  • point the hosted openapi reference at https://api.tembo.io/public-api/
  • update explicit hosted api examples and the snowflake integration base url
  • fix the remaining hosted url in the self-hosted openapi example

validation

  • mintlify validate
  • git diff --check
  • audited public api routes against monorepo/apps/api/src/server/routes/public-api
  • merged origin/main before committing (already up to date, no conflicts)

Want tembo to make any changes? Add a comment with @tembo and i'll get back to work!

View on Tembo  Review in Tembo  View Agent Settings  View on slack


Note

Low Risk
Documentation-only URL guidance; no runtime or API behavior changes.

Overview
Documentation now spells out the /api/public-api base for self-hosted Tembo instead of implying a plain deployment root URL.

The Snowflake Self-hosted Tembo accordion tells operators to set the Python UDF BASE to the public API base (e.g. https://tembo.example.com/api/public-api) and to update the egress network rule for the deployment host separately. The self-hosted OpenAPI Send Session Message cURL sample uses that same path prefix for POST .../session/{id}/messages.

Reviewed by Cursor Bugbot for commit 49d9175. Bugbot is set up for automated code reviews on this repo. Configure here.

Co-authored-by: Vinícius <36349314+vrmiguel@users.noreply.github.com>
@tembo tembo Bot added the tembo Pull request created by Tembo label Aug 7, 2026
@mintlify

mintlify Bot commented Aug 7, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tembo 🟢 Ready View Preview Aug 7, 2026, 12:09 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@tembo

tembo Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Requesting review from @DarrenBaldwin07 who has experience with the following files modified in this PR:

  • openapi.documented.yml
  • openapi.self-hosted.yml

@tembo

tembo Bot commented Aug 30, 2026

Copy link
Copy Markdown
Contributor

I verified these URLs against the latest published release, v0.2.828, and its successful production deployment.

Blocking merge as-is because the PR is stale relative to the released routing model:

  • Cloud's canonical public base is still https://api.tembo.io/, not https://api.tembo.io/public-api/. The released server intentionally publishes its OpenAPI server as https://api.tembo.io/, strips /public-api from generated path names, and rewrites root requests such as /session/list to the internal /public-api/session/list route. The infrastructure describes this as restoring the retired origin prefix.
  • Prefixed cloud URLs happen to remain accepted, but documenting that internal prefix would conflict with the released OpenAPI contract and with newer examples on main.
  • The self-hosted corrections are valid: self-hosted deployments use a base such as https://tembo.example.com/api/public-api/. In particular, the self-hosted messages example in openapi.self-hosted.yml should be retained.
  • The Snowflake self-hosted guidance is also directionally correct, but after retaining the canonical cloud base it should say to replace https://api.tembo.io with the deployment's public API base (for example, https://tembo.example.com/api/public-api) and separately allow that deployment host in the network rule.

Recommendation: rebase onto current main, drop every cloud /public-api addition, and retain only the self-hosted URL/example corrections. Do not merge the current diff.

@tembo tembo Bot added the blocked label Aug 30, 2026
tembo Bot and others added 2 commits August 30, 2026 18:05
@tembo

tembo Bot commented Aug 30, 2026

Copy link
Copy Markdown
Contributor

Fixed in dedicated verified commit 49d9175:

  • restored the released canonical cloud base, https://api.tembo.io/, throughout the overview, Snowflake example, and documented OpenAPI spec
  • retained the correct self-hosted base, https://tembo.example.com/api/public-api/
  • corrected the self-hosted Snowflake instructions to distinguish the API base from the network-rule host
  • updated the branch with current main

The resulting PR diff is now limited to two self-hosted URL corrections and is mergeable. Removing the blocked label.

@ryw

ryw commented Aug 30, 2026

Copy link
Copy Markdown
Member

@vrmiguel will you review the edits + confirm they are mergable, if so merge this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

tembo Pull request created by Tembo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants