docs: missing_docs sweep — 0 warnings + deny gate + publish-prep decisions (HY-02, HY-04, HY-11)

- document every public-API item across 18 files (openapi_spec model,
  HttpAuthScheme/HttpServiceConfig, HttpClientBuildError + SharedHttpClient
  accessors, RetryAfterMiddleware, GatewayDispatch, gateway error
  mapping, CallRequest/SchemaQuery/SubscribeStream, HttpAdapter +
  ALPNs + builders, decoy/healthz/state, WsSessions/WsPumps,
  from_openapi/from_jsonschema/from_mcp/from_wss/to_mcp, lib.rs module
  docs)
- enforcement: #![deny(missing_docs)] at crate root — stronger than CI
  rustdocflags (every build incl. cfg(test), where rustdoc misses the
  test-support module docs)
- HY-10 (opportunistic): all 8 docs.rs/alkhttp placeholder ADR links +
  the one relative ../docs link converted to plain text; the 10
  pre-existing private/redundant intra-doc-link warnings fixed —
  RUSTDOCFLAGS="-D warnings" cargo doc is fully clean
- HY-11 decision: docs/ + tasks/ excluded from the published package
  (contributor-facing design/process material; ADR references degrade
  to plain text uniformly). cargo publish --dry-run: 38 files, ~889 KiB,
  zero docs/ or tasks/ entries
- HY-04 decision: keep + document — frame_channel0_chunk's unwrap is
  on serializing the acyclic EventEnvelope (unreachable failure);
  # Panics on it and the adjacent WsClient senders state the contract

Verified: cargo test (299 + 5 TLS), --all-features (370 + suites),
--no-default-features (299), clippy --all-targets -D warnings
(default + all-features), fmt --check, cargo doc -D warnings clean,
cargo publish --dry-run --allow-dirty clean.

Tasks: review-001-missing-docs-sweep (final pending task; 42/42)
This commit is contained in:
2026-08-30 08:25:18 +00:00
parent 7ce1ca6fbd
commit 91483a74b4
22 changed files with 395 additions and 31 deletions
+11
View File
@@ -98,15 +98,22 @@ pub(crate) fn gateway_router() -> Router<RouterState> {
.route("/publish", post(publish_handler))
}
/// The `/call` and `/subscribe` request body: the target operation
/// (with or without a leading `/`) and its input object.
#[derive(Debug, Deserialize)]
pub struct CallRequest {
/// The operation name, qualified (`namespace/op`); a leading slash
/// is tolerated.
pub operation: String,
/// The operation input; defaults to null when the line omits it.
#[serde(default = "Value::default")]
pub input: Value,
}
/// The `GET /schema?name=<operation>` query parameters.
#[derive(Debug, Deserialize)]
pub struct SchemaQuery {
/// The operation name to project, qualified (`namespace/op`).
pub name: String,
}
@@ -212,6 +219,10 @@ pub(crate) async fn subscribe_handler(
.into_response()
}
/// The SSE projection stream of `POST /subscribe`: each item is one
/// wire-ready frame (a `data:` event or a keep-alive comment); the
/// stream is infallible — errors arrive as in-band `event: error`
/// frames (GW-04).
pub type SubscribeStream = BoxStream<'static, Result<Event, Infallible>>;
/// `POST /publish` (ADR-068): the body is NDJSON — one published chunk