Skip to content

Drop the prose I put in expose.proto - #185

Merged
vitramir merged 1 commit into
mainfrom
trim-expose-proto-comments
Aug 10, 2026
Merged

Drop the prose I put in expose.proto#185
vitramir merged 1 commit into
mainfrom
trim-expose-proto-comments

Conversation

@vitramir

Copy link
Copy Markdown
Contributor

Follow-up to #183.

Documentation belongs in the architecture repo, not in the wire contract. The field and enum comments that landed with the entity-named exposure change restated what the spec already says — how a hostname is derived, when it falls back to the opaque form, what an owner resolves to, why the owner-kind enum is not imported from runners. A proto carrying that prose goes stale the moment the spec moves, and there are now two places to read for one answer.

Removed: every comment #183 added.

Kept: the deprecation markers, which are structural, and the pre-existing rpc comments — with agent workload corrected to workload, since a sandbox exposes ports too.

No wire change. buf lint and buf breaking against main are both clean.

Documentation belongs in the architecture repo, not in the wire contract. The
field and enum comments added with the entity-named exposure change restated
what the spec already says -- how a hostname is derived, when it falls back,
what an owner resolves to -- and a proto that carries that prose goes stale the
moment the spec moves.

What stays is structural: the deprecation markers, and the pre-existing rpc
comments with "agent workload" corrected to "workload", since a sandbox exposes
ports too.
@vitramir
vitramir requested a review from a team as a code owner August 10, 2026 04:00
@github-actions

Copy link
Copy Markdown

The latest Buf updates on your PR. Results from workflow buf-pr / buf (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed✅ passed✅ passed✅ passedAug 10, 2026, 4:00 AM

@vitramir
vitramir merged commit c35854b into main Aug 10, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant