API Reference for ArangoPlatformConnector V1Beta1

Spec

.spec.deployment.name

Type: string ^[ref]

This field is required

Name of the object

.spec.description

Type: string ^[ref]

Description is a human-readable text explaining what this connector does. Shown to AI tools via /_inventory for discovery. Set by the user. Example: “Execute AQL queries on ArangoDB”

.spec.route.name

Type: string ^[ref]

This field is required

Name of the object

.spec.schema

Type: Object ^[ref]

Schema defines the JSON Schema that describes the expected format of the query field when submitting jobs to this connector. AI tools read this from /_inventory to validate input before creating a job. Set by the user. Uses the standard Kubernetes JSONSchemaProps format (same as CRD validation schemas). The platform validates submitted job queries against this schema.

Links:

Kubernetes JSON Schema docs

.spec.tags

Type: array ^[ref]

Tags are labels used by AI tools to discover and filter connectors via /_inventory. Set by the user. Use lowercase, descriptive terms. Example: [“database”, “aql”, “query”]

.spec.type

Type: string ^[ref]

Type defines the connector execution pattern. Currently only “Active” is supported — the connector runs as a long-lived process that polls for pending jobs and processes them sequentially. Set by the user when creating the connector. Defaults to “Active” if omitted.

Possible Values:

"Active" (default) - Connector actively polls for and processes jobs

.spec.version

Type: string ^[ref]

Version is the version string of the connector implementation. Set by the user. Shown to AI tools via /_inventory. No format enforced, but semantic versioning (e.g. “1.0.0”) is recommended.