[vadyvas]

Summary

Prepares the Cafe description to be the API of the Reunite project starter.

• redocly.yaml runs the starter rules. The sentence-case regex allows acronyms such as OAuth2.
• Every scalar schema property has examples, taken from the server seed data.
• Every error response has an example with the real server message.

The starter template must use the same regex. With the current one, 5 summaries with OAuth2 or (RFC 7591 names) fail.

[redocly]

cafe

AI Review: 🟢 Completed

Redocly Agent has reviewed your changes and found 8 potential issue(s).

Note

Low Risk

Updates OpenAPI documentation examples and Redocly configuration only. There are no runtime code modifications, zero operational impact on the service, and the blast radius is strictly confined to API documentation and lint validation.

Overview

Aligns the Cafe API definition with the Reunite starter lint rules and improves response documentation:

• Updates redocly.yaml with root-level rules enforcing tag definitions, example validity, and sentence-cased operation and example summaries (permitting acronyms like OAuth2).
• Adds realistic payload examples with server error messages across shared error response components (BadRequest, Conflict, Forbidden, NotFound, Unauthorized, InternalServerError, and OAuth2 responses).
• Updates date example summaries in openapi/paths/revenue.yaml to conform to the sentence-case rules.

Changed pages

⚙️ Configuration or theme changed

Open preview

[tatomyr]

Looks the same as OAuth2Unauthorized.yaml but different example, which makes the duplication unnecessary.

[redocly]

In OpenAPI 3.x, an Example Object uses the "value" property to hold the example data, not "dataValue". Please change "dataValue" to "value". Affected examples: NotFound, MenuItemNotFound, OrderNotFound.

[redocly]

Please also change "dataValue" to "value" in the InvalidToken example.