REST API Reference

v1.0.0

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

12 Endpoints
23 Schemas
4 Categories

Base URLs

https://api.demo.bengal.sh
https://staging.demo.bengal.sh

Authentication

bearerAuth

http
Authorization: Bearer YOUR_TOKEN

apiKeyAuth

apiKey
X-API-Key: YOUR_API_KEY

oauth2

oauth2
Authorization: Bearer ACCESS_TOKEN

Categories

Schemas

0

API data schemas and models.

Users

5

Orders

5

Payments

1

Inventory

1

Users

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

Orders

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

Payments

POST /orders/{orderId}/payments

Capture payment for an order

Inventory

GET /inventory/items/{sku}

Get inventory item

Schemas

BaseResource object
UserBase object
User object
UserCreate object
UserUpdate object
Address object
SessionCreate object
SessionToken object
OrderStatus string
Money object
OrderLineItem object
Order object
OrderCreate object
OrderUpdate object
PaginatedUserList object
PaginatedOrderList object
PaymentMethodCard object
PaymentMethodBank object
PaymentRequest object
Payment object
PaymentFailure object
InventoryItem object
ErrorResponse object