REST API

REST API Reference

Example OpenAPI specification used to demonstrate Bengal's autodoc OpenAPI extraction. The demo covers authentication, pagination, nested schemas, and polymorphic payment methods.

Version v1.0.0 Endpoints 12 Groups 4 Schemas 23

Endpoint catalog

Open an endpoint for parameters, response models, examples, and generated request snippets.

GET /users List users POST /users Create user GET /users/{userId} Get user PATCH /users/{userId} Update user profile POST /users/{userId}/sessions Create session token

GET /orders List orders POST /orders Create order GET /orders/{orderId} Get order DELETE /orders/{orderId} Cancel order PATCH /orders/{orderId} Update order status or metadata

POST /orders/{orderId}/payments Capture payment for an order

GET /inventory/items/{sku} Get inventory item

REST API Reference

Endpoint catalog

Users

Orders

Payments

Inventory