Skip to content

Commit e6cac7a

Browse files
committed
chore(spec): regenerate api-surface + reference docs for #4572 (check:generated --fix, 2 proved stale)
api-surface.json: -WebhookConfig(Schema)/-WebhookEvent(Schema) on ./api, +OpenApiWebhookEvent(Schema). Reference docs: the api/connector.mdx page (which documented only the removed ./api pair, under a misleading name) is no longer emitted; rest-server.mdx now documents OpenApiWebhookEvent. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01M9uWvoEp9CoLzYjNExj9sL
1 parent 4c9222a commit e6cac7a

4 files changed

Lines changed: 20 additions & 56 deletions

File tree

content/docs/references/api/connector.mdx

Lines changed: 0 additions & 49 deletions
This file was deleted.

content/docs/references/api/meta.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
"auth",
2828
"auth-endpoints",
2929
"automation-api",
30-
"connector",
3130
"core-services",
3231
"events",
3332
"export",

content/docs/references/api/rest-server.mdx

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ Architecture alignment:
3838
## TypeScript Usage
3939

4040
```typescript
41-
import { BatchEndpointsConfig, Callback, CrudEndpointPattern, CrudEndpointsConfig, CrudOperation, EndpointRegistry, GeneratedEndpoint, MetadataEndpointsConfig, OpenApi31Extensions, RestApiConfig, RestServerConfig, RouteGenerationConfig } from '@objectstack/spec/api';
42-
import type { BatchEndpointsConfig, Callback, CrudEndpointPattern, CrudEndpointsConfig, CrudOperation, EndpointRegistry, GeneratedEndpoint, MetadataEndpointsConfig, OpenApi31Extensions, RestApiConfig, RestServerConfig, RouteGenerationConfig } from '@objectstack/spec/api';
41+
import { BatchEndpointsConfig, Callback, CrudEndpointPattern, CrudEndpointsConfig, CrudOperation, EndpointRegistry, GeneratedEndpoint, MetadataEndpointsConfig, OpenApi31Extensions, OpenApiWebhookEvent, RestApiConfig, RestServerConfig, RouteGenerationConfig } from '@objectstack/spec/api';
42+
import type { BatchEndpointsConfig, Callback, CrudEndpointPattern, CrudEndpointsConfig, CrudOperation, EndpointRegistry, GeneratedEndpoint, MetadataEndpointsConfig, OpenApi31Extensions, OpenApiWebhookEvent, RestApiConfig, RestServerConfig, RouteGenerationConfig } from '@objectstack/spec/api';
4343

4444
// Validate data
4545
const result = BatchEndpointsConfig.parse(data);
@@ -173,6 +173,22 @@ const result = BatchEndpointsConfig.parse(data);
173173
| **pathItemReferences** | `boolean` || Allow $ref in path items (OpenAPI 3.1 feature) |
174174

175175

176+
---
177+
178+
## OpenApiWebhookEvent
179+
180+
### Properties
181+
182+
| Property | Type | Required | Description |
183+
| :--- | :--- | :--- | :--- |
184+
| **name** | `string` || Webhook event identifier (snake_case) |
185+
| **description** | `string` || Human-readable event description |
186+
| **method** | `Enum<'GET' \| 'POST' \| 'PUT' \| 'DELETE' \| 'PATCH' \| 'HEAD' \| 'OPTIONS'>` || HTTP method for webhook delivery |
187+
| **payloadSchema** | `string` || JSON Schema $ref for the webhook payload |
188+
| **headers** | `Record<string, string>` | optional | Custom headers to include in webhook delivery |
189+
| **security** | `Enum<'hmac_sha256' \| 'basic' \| 'bearer' \| 'api_key'>[]` || Supported authentication methods for webhook verification |
190+
191+
176192
---
177193

178194
## RestApiConfig

packages/spec/api-surface.json

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2939,6 +2939,8 @@
29392939
"OpenApiServerSchema (const)",
29402940
"OpenApiSpec (type)",
29412941
"OpenApiSpecSchema (const)",
2942+
"OpenApiWebhookEvent (type)",
2943+
"OpenApiWebhookEventSchema (const)",
29422944
"OperatorMapping (type)",
29432945
"OperatorMappingSchema (const)",
29442946
"PackageApiContracts (const)",
@@ -3195,10 +3197,6 @@
31953197
"WebSocketPresenceStatus (type)",
31963198
"WebSocketServerConfig (type)",
31973199
"WebSocketServerConfigSchema (const)",
3198-
"WebhookConfig (type)",
3199-
"WebhookConfigSchema (const)",
3200-
"WebhookEvent (type)",
3201-
"WebhookEventSchema (const)",
32023200
"WellKnownCapabilities (type)",
32033201
"WellKnownCapabilitiesSchema (const)",
32043202
"envelopeViolations (function)",

0 commit comments

Comments
 (0)