@oneplatform/plugin-sdk

@oneplatform/plugin-sdk / ConnectorMetadata

Interface: ConnectorMetadata¶

Defined in: packages/plugin-sdk/src/types/metadata.ts:37

Extends¶

• BaseMetadata

Properties¶

author¶

author: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:25

Plugin author name or organization.

Inherited from¶

BaseMetadata.author

category¶

category: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:44

Marketplace category. Standard values: "crm", "ecommerce", "database", "file", "analytics", "marketing", "finance", "devtools", "iot", "other".

configSchema¶

configSchema: JSONSchema

Defined in: packages/plugin-sdk/src/types/metadata.ts:31

JSON Schema for the tenant-admin configuration form.

Inherited from¶

BaseMetadata.configSchema

description¶

description: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:19

Brief description shown in the marketplace. 10-500 characters.

Inherited from¶

BaseMetadata.description

icon?¶

optional icon?: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:28

URL or data URI for the plugin icon. PNG or SVG, max 64KB.

Inherited from¶

BaseMetadata.icon

id¶

id: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:13

Must match manifest.id exactly.

Inherited from¶

BaseMetadata.id

name¶

name: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:16

Human-readable display name. 2-100 characters.

Inherited from¶

BaseMetadata.name

outputSchema¶

outputSchema: JSONSchema

Defined in: packages/plugin-sdk/src/types/metadata.ts:47

JSON Schema describing the shape of records this connector produces.

rateLimit?¶

optional rateLimit?: object

Defined in: packages/plugin-sdk/src/types/metadata.ts:60

Advisory rate limit hint for the Ingestion Service's scheduling algorithm. Does not enforce anything — the connector is responsible for enforcing its own rate limits by throwing PluginRateLimitError.

requestsPerMinute¶

requestsPerMinute: number

rowsPerSecond?¶

optional rowsPerSecond?: number

supportsIncremental¶

supportsIncremental: boolean

Defined in: packages/plugin-sdk/src/types/metadata.ts:50

True if the connector supports cursor-based incremental fetching.

supportsRealtime¶

supportsRealtime: boolean

Defined in: packages/plugin-sdk/src/types/metadata.ts:53

True if the connector implements subscribeToEvents().

tags?¶

optional tags?: string[]

Defined in: packages/plugin-sdk/src/types/metadata.ts:34

Discoverability tags shown in the marketplace filter UI.

Inherited from¶

BaseMetadata.tags

type¶

readonly type: "connector"

Defined in: packages/plugin-sdk/src/types/metadata.ts:38

version¶

version: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:22

Must match manifest.version exactly.

Inherited from¶

BaseMetadata.version