ObjectStackRouter
Router protocol schemas
Route Category Enum
Classifies routes for middleware application and security policies.
Source: packages/spec/src/api/router.zod.ts
TypeScript Usage
import { RouteCategory, RouteDefinition, RouterConfig } from '@objectstack/spec/api';
import type { RouteCategory, RouteDefinition, RouterConfig } from '@objectstack/spec/api';
// Validate data
const result = RouteCategory.parse(data);RouteCategory
Allowed Values
systemapiauthstaticwebhookplugin
RouteDefinition
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| method | Enum<'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS'> | ✅ | |
| path | string | ✅ | URL Path pattern |
| category | Enum<'system' | 'api' | 'auth' | 'static' | 'webhook' | 'plugin'> | ✅ | |
| handler | string | ✅ | Unique handler identifier |
| summary | string | optional | OpenAPI summary |
| description | string | optional | OpenAPI description |
| public | boolean | ✅ | Is publicly accessible |
| permissions | string[] | optional | Required permissions |
| timeout | integer | optional | Execution timeout in ms |
| rateLimit | string | optional | Rate limit policy name |
RouterConfig
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| basePath | string | ✅ | Global API prefix |
| mounts | Object | ✅ | |
| cors | Object | optional | |
| staticMounts | Object[] | optional |