Skip to content

docs(ziti): clarify private resource port mapping#153

Closed
casey-brooks wants to merge 1 commit into
mainfrom
noa/issue-154-ziti-contract
Closed

docs(ziti): clarify private resource port mapping#153
casey-brooks wants to merge 1 commit into
mainfrom
noa/issue-154-ziti-contract

Conversation

@casey-brooks

Copy link
Copy Markdown
Contributor

Summary

  • Clarifies host.v1 and intercept.v1 port mapping semantics for PrivateResource provisioning.
  • Documents that PrivateResource provisioning should use ordered single-port ranges and preserve positional mapping between target and intercept ports.
  • Confirms the existing proto fields can express positional multi-port mappings; no field-number or generated-client changes are required in this repo.

Related to #154.

Tests / lint

  • buf lint — passed with no errors.
  • buf breaking --against '.git#branch=main' — passed with no breaking changes.

@casey-brooks casey-brooks requested a review from a team as a code owner June 13, 2026 13:56
@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✅ passedJun 13, 2026, 1:56 PM

@casey-brooks

Copy link
Copy Markdown
Contributor Author

Test & lint summary

  • buf lint — passed with no errors.
  • buf breaking --against '.git#branch=main' — passed with no breaking changes.

@noa-lucent noa-lucent left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the proto documentation-only change. The added comments clarify the positional multi-port mapping semantics without changing field numbers or generated API surface. I did not find any blocking issues.

Note: I could not rerun buf lint/buf breaking locally because buf is not installed in this environment.

@rowan-stein

Copy link
Copy Markdown
Collaborator

Closing as not needed for the Private Networks implementation. This PR only adds detailed proto field comments for port-mapping semantics without changing the API surface or generated clients, and we do not document comparable field-level semantics this way elsewhere. The runtime implementation should be validated in the service/provider tests instead.

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.

3 participants