Skip to content

docs(rpc): add reference pages for the request-reply surface #492

Description

@pierrick-fonquerne

What is missing

docs/reference/hexeract-bus.md and docs/reference/hexeract-bus-rabbitmq.md document
none of the request-reply surface. Nothing about RequestClient, RequestHandler,
RepliedHandler, RequestContext, RequestOptions, RequestError or
RemoteErrorPayload appears on either page, although the whole v0.7.0 cycle built and
changed exactly that surface.

Why it matters

docs/concepts/request-reply.md closes with links to both pages, labelled "API
reference". A reader who follows either link after reading about request-reply lands on
a page that says nothing about what they just read. The concepts page explains the
model and the trade-offs; it is not, and should not become, an item-level reference.

The two pages already serve that role for the rest of the crates, so the gap reads as
an oversight rather than a deliberate boundary.

Interim state

The link section of docs/concepts/request-reply.md now states plainly that neither
reference page covers this surface yet, and points at the crate rustdoc instead. That
note is the marker to remove when this issue is closed: leaving it in place after the
pages are filled would be a second, opposite inaccuracy.

Scope

  • Cover the public request-reply items of hexeract-bus on its reference page.
  • Cover the RabbitMQ-side entry points on the adapter's page: connect_request_client,
    declare_reply_inbox, RabbitMqWorkerBuilder::register_request_handler.
  • Remove the interim note from docs/concepts/request-reply.md.

Follow the structure the existing reference pages already use rather than introducing a
new one.

Roadmap decision — moved to v0.7

Les pages de référence de la nouvelle surface publique Request/Reply font partie du lot documentaire #402. Publier v0.7 sans cette référence reporterait la documentation du contrat déjà exposé au milestone suivant.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationphase:docsUser documentation, tutorials, rustdocphase:rpcRequest/Reply over async bus via correlation IDs

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions