Repository navigation
docs: show the console path for the two network operations that have one - #60
Merged
Mandalorian-Wang merged 1 commit intoOct 21, 2026
Conversation
The page taught every inbound operation as a curl call. Two of the four
are in the console, and the console is where someone doing this by hand
will actually do it. Read the dashboard source rather than guessing which
ones:
apps/dashboard/src/components/boxes/BoxNetworkSection.tsx
useUpdateBoxInboundMutation -> change inbound on an existing box
useBoxPreviewUrlMutation -> get a preview URL for a port
Both render in BoxDetails.tsx as a `network` panel. The other two —
issuing and revoking a signed URL — have no console control and no SDK or
CLI method, so they really are HTTP-only and now say so.
Added a "Where to do each of these" matrix up front, because the honest
answer to "why is this all curl?" is that the surfaces differ per
operation, and the reader should see that before the first code block
rather than inferring it.
Two facts from the dashboard source worth having:
- The console states inbound as `disabled · your organization` versus
`enabled · anyone`, which is a better description than "private" and
"public". Disabled does not mean unreachable: a visitor is sent through
sign-in and served if they are a member. The panel's own comment says
as much.
- **`get url` is disabled while inbound is disabled, but the HTTP route
is not** — it returns a URL and token for a private box, which is what
the token flow on this page is for. Verified against production: `GET
/box/dasdas/ports/8080/preview-url` returns 200 for a box whose
`public` is false. Someone finding the button greyed out would
otherwise conclude the feature is broken.
Also noted that `outbound` on that panel is read-only, since nothing
changes a box's egress after create.
This is the smallest version of the restructure the plan deferred: it
adds the missing surfaces without reordering the page.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Preview approval requiredThis pull request comes from a fork, so Mintlify won't build a preview until someone with write access approves commit |
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configuration
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
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.
Answers a fair question about the published page: why is so much of this only
shown as REST?
Partly because the restructure was deliberately deferred — the earlier network work
was scoped to correcting facts, not reordering the page. But partly because I never
checked which operations have a non-HTTP surface. Two of the four do.
Read the dashboard source rather than guessing:
Both render in
BoxDetails.tsxas a network panel. The other two — issuing andrevoking a signed URL — have no console control and no SDK or CLI method, so they
genuinely are HTTP-only, and the page now says so instead of leaving the reader to
wonder.
The matrix goes up front, because the honest answer to "why is this all curl?" is
that the surfaces differ per operation, and a reader deserves to see that before
the first code block rather than inferring it from what is missing.
Two facts from the dashboard source worth having
disabled · your organizationversusenabled · anyone. Disabled does not meanunreachable — a visitor is sent through sign-in and served if they are a member of
your organization. The panel's own source comment says exactly that.
get urlis disabled while inbound is disabled — but the HTTP route is not.It returns a URL and token for a private box too, which is what this page's token
flow is for. Verified against production:
GET /box/dasdas/ports/8080/preview-urlreturns
200for a box whosepublicisfalse. Someone finding the buttongreyed out would otherwise reasonably conclude the feature is broken.
Also recorded that
outboundon that panel is read-only, since nothing changes abox's egress after create.
This is the smallest useful version of the deferred restructure: it adds the missing
surfaces without reordering the page.
Checks
🤖 Generated with Claude Code