Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions content/docs/references/api/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"contract",
"discovery",
"endpoint",
"odata",
"realtime",
"router"
]
Expand Down
10 changes: 10 additions & 0 deletions content/docs/references/api/odata/ODataError.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: ODataError
description: ODataError Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **error** | `object` | ✅ | |
35 changes: 35 additions & 0 deletions content/docs/references/api/odata/ODataFilterFunction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: ODataFilterFunction
description: ODataFilterFunction Schema Reference
---

## Allowed Values

* `contains`
* `startswith`
* `endswith`
* `length`
* `indexof`
* `substring`
* `tolower`
* `toupper`
* `trim`
* `concat`
* `year`
* `month`
* `day`
* `hour`
* `minute`
* `second`
* `date`
* `time`
* `now`
* `maxdatetime`
* `mindatetime`
* `round`
* `floor`
* `ceiling`
* `cast`
* `isof`
* `any`
* `all`
20 changes: 20 additions & 0 deletions content/docs/references/api/odata/ODataFilterOperator.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: ODataFilterOperator
description: ODataFilterOperator Schema Reference
---

## Allowed Values

* `eq`
* `ne`
* `lt`
* `le`
* `gt`
* `ge`
* `and`
* `or`
* `not`
* `(`
* `)`
* `in`
* `has`
12 changes: 12 additions & 0 deletions content/docs/references/api/odata/ODataMetadata.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: ODataMetadata
description: ODataMetadata Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **namespace** | `string` | ✅ | Service namespace |
| **entityTypes** | `object[]` | ✅ | Entity types |
| **entitySets** | `object[]` | ✅ | Entity sets |
19 changes: 19 additions & 0 deletions content/docs/references/api/odata/ODataQuery.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: ODataQuery
description: ODataQuery Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **$select** | `string \| string[]` | optional | Fields to select |
| **$filter** | `string` | optional | Filter expression (OData filter syntax) |
| **$orderby** | `string \| string[]` | optional | Sort order |
| **$top** | `integer` | optional | Max results to return |
| **$skip** | `integer` | optional | Results to skip |
| **$expand** | `string \| string[]` | optional | Navigation properties to expand |
| **$count** | `boolean` | optional | Include total count |
| **$search** | `string` | optional | Search expression |
| **$format** | `Enum<'json' \| 'xml' \| 'atom'>` | optional | Response format |
| **$apply** | `string` | optional | Aggregation expression |
13 changes: 13 additions & 0 deletions content/docs/references/api/odata/ODataResponse.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: ODataResponse
description: ODataResponse Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **@odata.context** | `string` | optional | Metadata context URL |
| **@odata.count** | `integer` | optional | Total results count |
| **@odata.nextLink** | `string` | optional | Next page URL |
| **value** | `Record<string, any>[]` | ✅ | Results array |
3 changes: 3 additions & 0 deletions content/docs/references/api/odata/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"title": "Odata"

Copilot AI Jan 27, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs nav title capitalization is inconsistent with the protocol name. Consider changing the title from "Odata" to "OData".

Suggested change
"title": "Odata"
"title": "OData"

Copilot uses AI. Check for mistakes.
}
17 changes: 17 additions & 0 deletions content/docs/references/automation/connector/AuthField.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: AuthField
description: AuthField Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Field name (snake_case) |
| **label** | `string` | ✅ | Field label |
| **type** | `Enum<'text' \| 'password' \| 'url' \| 'select'>` | optional | Field type |
| **description** | `string` | optional | Field description |
| **required** | `boolean` | optional | Required field |
| **default** | `string` | optional | Default value |
| **options** | `object[]` | optional | Select field options |
| **placeholder** | `string` | optional | Placeholder text |
13 changes: 13 additions & 0 deletions content/docs/references/automation/connector/Authentication.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Authentication
description: Authentication Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **type** | `Enum<'none' \| 'apiKey' \| 'basic' \| 'bearer' \| 'oauth1' \| 'oauth2' \| 'custom'>` | ✅ | Authentication type |
| **fields** | `object[]` | optional | Authentication fields |
| **oauth2** | `object` | optional | OAuth 2.0 configuration |
| **test** | `object` | optional | Authentication test configuration |
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: AuthenticationType
description: AuthenticationType Schema Reference
---

## Allowed Values

* `none`
* `apiKey`
* `basic`
* `bearer`
* `oauth1`
* `oauth2`
* `custom`
27 changes: 27 additions & 0 deletions content/docs/references/automation/connector/Connector.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: Connector
description: Connector Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | ✅ | Connector ID (snake_case) |
| **name** | `string` | ✅ | Connector name |
| **description** | `string` | optional | Connector description |
| **version** | `string` | optional | Connector version |
| **icon** | `string` | optional | Connector icon |
| **category** | `Enum<'crm' \| 'payment' \| 'communication' \| 'storage' \| 'analytics' \| 'database' \| 'marketing' \| 'accounting' \| 'hr' \| 'productivity' \| 'ecommerce' \| 'support' \| 'devtools' \| 'social' \| 'other'>` | ✅ | Connector category |
| **baseUrl** | `string` | optional | API base URL |
| **authentication** | `object` | ✅ | Authentication config |
| **operations** | `object[]` | optional | Connector operations |
| **triggers** | `object[]` | optional | Connector triggers |
| **rateLimit** | `object` | optional | Rate limiting |
| **author** | `string` | optional | Connector author |
| **documentation** | `string` | optional | Documentation URL |
| **homepage** | `string` | optional | Homepage URL |
| **license** | `string` | optional | License (SPDX identifier) |
| **tags** | `string[]` | optional | Connector tags |
| **verified** | `boolean` | optional | Verified connector |
| **metadata** | `Record<string, any>` | optional | Custom metadata |
22 changes: 22 additions & 0 deletions content/docs/references/automation/connector/ConnectorCategory.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: ConnectorCategory
description: ConnectorCategory Schema Reference
---

## Allowed Values

* `crm`
* `payment`
* `communication`
* `storage`
* `analytics`
* `database`
* `marketing`
* `accounting`
* `hr`
* `productivity`
* `ecommerce`
* `support`
* `devtools`
* `social`
* `other`
19 changes: 19 additions & 0 deletions content/docs/references/automation/connector/ConnectorInstance.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: ConnectorInstance
description: ConnectorInstance Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | ✅ | Instance ID |
| **connectorId** | `string` | ✅ | Connector ID |
| **name** | `string` | ✅ | Instance name |
| **description** | `string` | optional | Instance description |
| **credentials** | `Record<string, any>` | ✅ | Encrypted credentials |
| **config** | `Record<string, any>` | optional | Additional config |
| **active** | `boolean` | optional | Instance active status |
| **createdAt** | `string` | optional | Creation time |
| **lastTestedAt** | `string` | optional | Last test time |
| **testStatus** | `Enum<'unknown' \| 'success' \| 'failed'>` | optional | Connection test status |
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: ConnectorOperation
description: ConnectorOperation Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | ✅ | Operation ID (snake_case) |
| **name** | `string` | ✅ | Operation name |
| **description** | `string` | optional | Operation description |
| **type** | `Enum<'read' \| 'write' \| 'delete' \| 'search' \| 'trigger' \| 'action'>` | ✅ | Operation type |
| **inputSchema** | `object[]` | optional | Input parameters |
| **outputSchema** | `Record<string, any>` | optional | Output schema |
| **sampleOutput** | `any` | optional | Sample output |
| **supportsPagination** | `boolean` | optional | Supports pagination |
| **supportsFiltering** | `boolean` | optional | Supports filtering |
16 changes: 16 additions & 0 deletions content/docs/references/automation/connector/ConnectorTrigger.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: ConnectorTrigger
description: ConnectorTrigger Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | ✅ | Trigger ID (snake_case) |
| **name** | `string` | ✅ | Trigger name |
| **description** | `string` | optional | Trigger description |
| **type** | `Enum<'webhook' \| 'polling' \| 'stream'>` | ✅ | Trigger mechanism |
| **config** | `Record<string, any>` | optional | Trigger configuration |
| **outputSchema** | `Record<string, any>` | optional | Event payload schema |
| **pollingIntervalMs** | `integer` | optional | Polling interval in ms |
14 changes: 14 additions & 0 deletions content/docs/references/automation/connector/OAuth2Config.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: OAuth2Config
description: OAuth2Config Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **authorizationUrl** | `string` | ✅ | Authorization endpoint URL |
| **tokenUrl** | `string` | ✅ | Token endpoint URL |
| **scopes** | `string[]` | optional | OAuth scopes |
| **clientIdField** | `string` | optional | Client ID field name |
| **clientSecretField** | `string` | optional | Client secret field name |
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: OperationParameter
description: OperationParameter Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Parameter name |
| **label** | `string` | ✅ | Parameter label |
| **description** | `string` | optional | Parameter description |
| **type** | `Enum<'string' \| 'number' \| 'boolean' \| 'array' \| 'object' \| 'date' \| 'file'>` | ✅ | Parameter type |
| **required** | `boolean` | optional | Required parameter |
| **default** | `any` | optional | Default value |
| **validation** | `Record<string, any>` | optional | Validation rules |
| **dynamicOptions** | `string` | optional | Function to load dynamic options |
13 changes: 13 additions & 0 deletions content/docs/references/automation/connector/OperationType.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: OperationType
description: OperationType Schema Reference
---

## Allowed Values

* `read`
* `write`
* `delete`
* `search`
* `trigger`
* `action`
3 changes: 3 additions & 0 deletions content/docs/references/automation/connector/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"title": "Connector"
}
14 changes: 14 additions & 0 deletions content/docs/references/automation/etl/ETLDestination.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: ETLDestination
description: ETLDestination Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **type** | `Enum<'database' \| 'api' \| 'file' \| 'stream' \| 'object' \| 'warehouse' \| 'storage' \| 'spreadsheet'>` | ✅ | Destination type |
| **connector** | `string` | optional | Connector ID |
| **config** | `Record<string, any>` | ✅ | Destination configuration |
| **writeMode** | `Enum<'append' \| 'overwrite' \| 'upsert' \| 'merge'>` | optional | How to write data |
| **primaryKey** | `string[]` | optional | Primary key fields |
15 changes: 15 additions & 0 deletions content/docs/references/automation/etl/ETLEndpointType.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: ETLEndpointType
description: ETLEndpointType Schema Reference
---

## Allowed Values

* `database`
* `api`
* `file`
* `stream`
* `object`
* `warehouse`
* `storage`
* `spreadsheet`
22 changes: 22 additions & 0 deletions content/docs/references/automation/etl/ETLPipeline.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: ETLPipeline
description: ETLPipeline Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Pipeline identifier (snake_case) |
| **label** | `string` | optional | Pipeline display name |
| **description** | `string` | optional | Pipeline description |
| **source** | `object` | ✅ | Data source |
| **destination** | `object` | ✅ | Data destination |
| **transformations** | `object[]` | optional | Transformation pipeline |
| **syncMode** | `Enum<'full' \| 'incremental' \| 'cdc'>` | optional | Sync mode |
| **schedule** | `string` | optional | Cron schedule expression |
| **enabled** | `boolean` | optional | Pipeline enabled status |
| **retry** | `object` | optional | Retry configuration |
| **notifications** | `object` | optional | Notification settings |
| **tags** | `string[]` | optional | Pipeline tags |
| **metadata** | `Record<string, any>` | optional | Custom metadata |
Loading
Loading