feat(client): standardize connection outcomes (#13)
quality-gate / quality (push) Successful in 59s
quality-gate / quality (push) Successful in 59s
This commit is contained in:
@@ -40,9 +40,7 @@ the same value as a required query parameter.
|
||||
| `GET` | `/health/ready` | Report whether the UDP mediator is bound and ready. |
|
||||
|
||||
The generated [OpenAPI document](../api/rendezvous-v1.json) is the normative
|
||||
shape reference for parameters, bodies, and responses. Contract-only endpoints
|
||||
return `501` until their behavior is implemented by the subsequent directory,
|
||||
lease, and join-orchestration issues.
|
||||
shape reference for parameters, bodies, and responses.
|
||||
|
||||
Host polling sends its reusable lease credential in
|
||||
`X-Rendezvous-Lease-Token`; it must never be placed in a URL. Lease credentials
|
||||
@@ -55,6 +53,24 @@ Attempt cancellation sends the short-lived client punch capability in
|
||||
source only for a process-keyed, short-lived idempotency/abuse scope; this is not
|
||||
player authentication and is never returned to callers.
|
||||
|
||||
Outcome reporting uses that same short-lived capability. It accepts only outcomes
|
||||
for an issued attempt and carries one stable outcome enum plus one coarse elapsed
|
||||
bucket. Exact duplicate reports are idempotent; conflicting repeats fail. Reports
|
||||
never carry exact timing, diagnostics, endpoints, metadata, player identifiers,
|
||||
or credentials.
|
||||
|
||||
The frozen v1 .NET request also retains deprecated `elapsedMilliseconds` and
|
||||
`diagnosticCode` properties for source/wire compatibility. Current clients omit
|
||||
them. If a legacy client supplies them, the server immediately converts elapsed
|
||||
milliseconds to the coarse bucket and discards diagnostic text; neither value is
|
||||
retained or used as a metric dimension.
|
||||
|
||||
Registration and update may include one validated `dedicatedFallback`. The
|
||||
endpoint must be enabled by the tenant's provisioned fallback policy, is visible
|
||||
browser data, and is copied into subsequently issued attempts.
|
||||
It is a handoff for caller-owned policy: neither the HTTP service nor the SDK
|
||||
automatically connects to it. V1 provides no gameplay relay.
|
||||
|
||||
## Idempotency, cursors, and retries
|
||||
|
||||
Registration and join creation require a caller-generated visible-ASCII
|
||||
@@ -101,9 +117,9 @@ must not be parsed. Secrets and raw credentials are never echoed.
|
||||
| 401 | `authenticationRequired` |
|
||||
| 403 | `forbidden` |
|
||||
| 404 | `notFound` |
|
||||
| 409 | `conflict`, `incompatibleProtocol`, `replayRejected`, `capacityExceeded` |
|
||||
| 409 | `conflict`, `incompatibleProtocol`, `replayRejected` |
|
||||
| 410 | `expired`, `staleHost` |
|
||||
| 429 | `rateLimited` (with retry guidance when known) |
|
||||
| 429 | `rateLimited`, `capacityExceeded` (with retry guidance when known) |
|
||||
| 503 | `serviceUnavailable` (with retry guidance when known) |
|
||||
| 500 | `internalError` |
|
||||
|
||||
|
||||
Reference in New Issue
Block a user