docs(publisher): fix project→environment API drift in publishing guides#328
Draft
ofermend wants to merge 1 commit into
Draft
docs(publisher): fix project→environment API drift in publishing guides#328ofermend wants to merge 1 commit into
ofermend wants to merge 1 commit into
Conversation
The Publisher API renamed the top-level concept from "project" to "environment", but the publishing user guides still used the old terms, so copy-pasted commands and configs failed against a current server: - publisher.config.json key `projects` → `environments` (in publishing.malloynb and all 14 examples in connections.malloynb). - List/status curls use `/api/v0/environments` and `/api/v0/status` (were `/api/v1/projects`, a bare `/status`, and a bad Compose healthcheck). - MCP tool `malloy_projectList` → `malloy_environmentList`, and the tool parameter `projectName` → `environmentName`. - REST query endpoint: the removed `.../queryResults/<model>` path is now `POST .../models/<model>/query`; `QueryResult.result` is a JSON string, so the examples parse it and pass `compactJson`. The SDK's `optionalProjectName` prop keeps its name (it maps to environmentName internally) and is left unchanged. Signed-off-by: Ofer Mendelevitch <ofermend@gmail.com>
ofermend
marked this pull request as draft
July 11, 2026 22:14
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The Publisher API renamed its top-level concept from project to environment, but the Publishing user guides still used the old terms. As a result, several copy-pasted commands and config snippets fail against a current Publisher server. This corrects the drift across the four affected pages.
Changes
publisher.config.jsonkeyprojects→environments— inpublishing.malloynband all 14 example configs inconnections.malloynb(the config root key is nowenvironments).List Environments/Healthcurls use/api/v0/environmentsand/api/v0/status(were/api/v1/projects, a bare/status, and a broken Docker Compose healthcheck against/status).malloy_projectList→malloy_environmentList; tool parameterprojectName→environmentName..../queryResults/<model>path is nowPOST .../models/<model>/query.QueryResult.resultis a JSON string, so the examples now parse it and passcompactJson.Deliberately unchanged
optionalProjectNameprop keeps its name — it maps toenvironmentNameinternally inpackages/sdk/src/components/QueryResult/QueryResult.tsx, so the docs are correct as-is.project_idinside the BigQuery service-account JSON example (a real GCP field).Verification
Every change was checked against the Publisher repo:
api-doc.yaml(31/environments/...paths, zeroprojects;POST .../models/{path}/query;QueryResult.result: string) and the MCP tool source (packages/server/src/mcp/tools/discovery_tools.tsusesenvironmentName).Part of a broader Publisher onboarding review.
🤖 Generated with Claude Code