sandbox: restore /api/2.0/lakebox/... in doc comments#5491
Merged
akshaysingla-db merged 1 commit intoJun 9, 2026
Merged
Conversation
Contributor
Waiting for approvalCould not determine reviewers from git history. Eligible reviewers: Suggestions based on git history. See OWNERS for ownership rules. |
The lakebox → sandbox rename PR (databricks#5487) did a bulk sed that incorrectly rewrote 14 documentation comments naming the actual HTTP endpoints. The wire path is `/api/2.0/lakebox/...` (server-side rename pending — see the sandboxAPIRoot constant), but the docstrings on list/get/create/update/delete/start/stop/registerKey/listKeys/ deleteKey/listResponse/registerKeyRequest were left saying `/api/2.0/sandbox/...`, misleading any reader who treats the comment as canonical. Also restores the keyhash_test.go header comment that mentions where the algorithm was verified. Behavior unchanged; comments now match the actual `Pattern` strings in the acceptance tests and the live URLs the CLI sends. Co-authored-by: Isaac
akshaysingla-db
force-pushed
the
akshay/sandbox-api-doc-comments
branch
from
June 9, 2026 19:46
323a631 to
8311bbb
Compare
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.
Summary
Follow-up to #5487. The bulk sed in that PR incorrectly rewrote 14 documentation comments that name the actual HTTP endpoints — the wire path is
/api/2.0/lakebox/...(server-side rename pending; see thesandboxAPIRootconst), but the doc comments onlist/get/create/update/delete/start/stop/registerKey/listKeys/deleteKey/listResponse/registerKeyRequestwere left saying/api/2.0/sandbox/....That mismatch is misleading — any reader treating the comment as canonical would look for a non-existent endpoint. Restoring all 14 to the actual wire path. Also restores the
keyhash_test.goheader comment that documents where the algorithm was verified.Behavior unchanged; comments now match the
[[Server]] Patternstrings in the acceptance tests and the URLs the CLI actually sends.Test plan
go test ./cmd/sandbox/...passesgo build ./...cleanNote
This is stacked on #5487 (
lakebox→sandboxrename). Until that merges, the diff here shows the rename + the doc-comment fix together. After #5487 lands ondemo-lakebox, this PR's diff collapses to just the 14 doc-comment line edits.This pull request and its description were written by Isaac.