# The /api/public OpenAPI document describes its fields in English, with examples

- Date: 2026-10-27
- Type: Non-breaking change
- Surface: /api/public
- What you need to do: Nothing.
- Address: https://developers.rivr.io/changelog/2026-10-27-api-public-descriptions-in-english

The descriptions in the /api/public OpenAPI document (/openapi/api-public.json, the API reference and the MCP tool get_openapi) are written in English for an integrator. They no longer show Rivr's internal type names, such as `Se Rivr.PublicApi.Contracts.Onboarding.OnboardingLinkStatuses.` for an onboarding link's `status`, which now lists its seven values and what each means. `orderId`, `orderSettlementId` and `Idempotency-Key` have a real example value, which the reference uses in its sample calls, and the 204 answers of the order settlement endpoints are described. Some texts are corrected: an onboarding link list shows your platform's onboardings, including those your platform's staff start in the platform portal; `unitPriceExclVat` is the price excluding VAT; and `payment_in_progress` and `order_changed` get separate advice, as on their error pages. The sandbox has it now, and production with Rivr's next release. Schema names, operation ids, types and the API's answers are unchanged.