Developers
Blog
Contact
Forum
Xapix Documentation
Release notes
Product Roadmap
Tutorials
Xapix quickstart
Building a pipeline
Getting Started
Installation
User accounts
Setting Up
Organizations
Projects
Resources
Data sources
Authentication
Cache connections
Proxies
Sharing resources
Execution definitions
REST/SOAP endpoints
Event streams
Scheduler
Functional dashboards
Pipeline dashboard
Mapping dashboard
Flow units
Publishing tools
API publishing
User Management
Debugging dashboard
Insights dashboard
Advanced
Xapix CLI (xapixctl)
Check pipelines
Axel-f
Axel-f functions
Reference
Resource definition
Glossary of terms
Powered by GitBook

Resource definition

Ambassador (v1)

The Ambassador resource describes a Xapix Ambassador used for easy network traversal.

Definition details

kind: Ambassador
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # The Ambassador's UUID (required).
  uuid: <string>

ApiPublishing (v1)

The ApiPublishing resource describes settings around API publishing, user management and rate limiting. See https://docs.xapix.io/publishing-tools/api-publishing for more details.

Definition details

kind: ApiPublishing
version: v1
metadata:
  # The ID has to be same as project id for ApiPublishing (optional).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # API publishing enabled? (required).
  enabled: true | false
  # Enables sending CORS headers for all endpoints (optional).
  cors_enabled: true | false
  # List of allowed origins for the Access-Control-Allow-Origin header
  # (optional).
  cors_origins:
    - <string>
  # User management component; if set to custom, use your custom
  # check-pipelines to extract user details from the request (required).
  user_management: shisa | custom
  # Store used for rate limiting data (optional).
  rate_limit_store: <string>
  # Key pair for generating/validating JWTs; used by the Xapix user
  # management component (shisa) (optional).
  jwt_credential: <string>

ApiPublishingRole (v1)

This describes a role for API access. To restrict access to your API using those roles, API publishing needs to be enabled. See https://docs.xapix.io/publishing-tools/api-publishing for more details.

Definition details

kind: ApiPublishingRole
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Type of role (required).
  type: custom_access | no_access | all_access
  # Rate limits for users with this role (optional).
  rate_limits:
    - # Schema: rate_limit
      # Duration of the rate limit window in seconds (required).
      seconds: <integer>
      # Number of allowed requests in given time window (required).
      requests: <integer>
  # List of accessible endpoints (for custom_access type) (optional).
  endpoints:
    - <string>

AuthScheme/Aws (v1)

The AuthScheme/Aws resource describes an authentication scheme for signing requests to AWS services. See https://docs.xapix.io/resources/authentication for more details.

Definition details

kind: AuthScheme/Aws
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Name of AWS service (required).
  service: <string>
  # Name of AWS region (required).
  region: <string>

AuthScheme/BasicAuth (v1)

The AuthScheme/BasicAuth resource describes an authentication scheme using HTTP Basic authentication. See https://docs.xapix.io/resources/authentication for more details.

Definition details

kind: AuthScheme/BasicAuth
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>

AuthScheme/BearerToken (v1)

The AuthScheme/BearerToken resource describes an authentication scheme using HTTP Bearer authentication. See https://docs.xapix.io/resources/authentication for more details.

Definition details

kind: AuthScheme/BearerToken
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>

AuthScheme/Cookie (v1)

The AuthScheme/Cookie resource describes an authentication scheme using a HTTP cookie. See https://docs.xapix.io/resources/authentication for more details.

Definition details

kind: AuthScheme/Cookie
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Name of the cookie expected to be used to hold the credential
  # (required).
  cookie: <string>

AuthScheme/OAuth2 (v1)

The AuthScheme/OAuth2 resource describes an authentication scheme using OAuth2. See https://docs.xapix.io/resources/authentication for more details.

Definition details

kind: AuthScheme/OAuth2
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # URL to the OAuth2 token endpoint (required).
  url: <string>

AuthScheme/Token (v1)

The AuthScheme/Token resource describes an authentication scheme using tokens in the header or query of the request. See https://docs.xapix.io/resources/authentication for more details.

Definition details

kind: AuthScheme/Token
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # The parameter expected to be used to hold the credential (required).
  parameter: # Schema: auth_scheme_param
    # Parameter name (required).
    name: <string>
    # Parameter type (required).
    type: header | query

CacheConnection/Memcached (v1)

Definition details

kind: CacheConnection/Memcached
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Ambassador (optional).
  ambassador: <string>
  # Hostnames (optional).
  hostnames:
    - <string>

CacheConnection/Redis (v1)

Definition details

kind: CacheConnection/Redis
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Ambassador (optional).
  ambassador: <string>
  # Uri (optional).
  uri: <string>

Credential/PublicPrivateKey (v1)

Definition details

kind: Credential/PublicPrivateKey
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Public Key (optional).
  public_key: <string>
  # Private Key (optional).
  private_key: <string>

Credential/Token (v1)

Definition details

kind: Credential/Token
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Token (optional).
  token: <string>

Credential/UserPassword (v1)

Definition details

kind: Credential/UserPassword
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Username (optional).
  username: <string>
  # Password (optional).
  password: <string>

DataSource/ExternalExecutor (v1)

Definition details

kind: DataSource/ExternalExecutor
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # External Executor Name (required).
  executor_name: <string>
  # External Executor Token (optional).
  executor_token: <string>
  # Schema describing the expected parameters for this data source
  # (optional).
  parameters:
    - # Schema: ds_param_attr
      # Field name (required).
      name: <string>
      # Type for this field (optional).
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
      # Nested fields, in case type is object (optional).
      properties:
        - <ds_param_attr> # see schema defintion above
      # Sample data (optional).
      sample: <any>
  # Schema describing the format of the response of this data source
  # (optional).
  attributes:
    - # Schema: ds_param_attr
      # Field name (required).
      name: <string>
      # Type for this field (optional).
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
      # Nested fields, in case type is object (optional).
      properties:
        - <ds_param_attr> # see schema defintion above
      # Sample data (optional).
      sample: <any>

DataSource/ExternalExecutor (v2)

Definition details

kind: DataSource/ExternalExecutor
version: v2
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # External Executor Name (required).
  executor_name: <string>
  # External Executor Token (optional).
  executor_token: <string>
  # Schema describing the expected parameters for this data source
  # (optional).
  parameter_schema: # Schema: json_schema
  # Data sample for the expected parameters (optional).
  parameter_sample: <object>
  # Schema describing the format of the response of this data source
  # (optional).
  attribute_schema: # Schema: json_schema
  # Data sample for the response (optional).
  attribute_sample: <object>

DataSource/REST (v1)

Definition details

kind: DataSource/REST
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # URL for accessing the data source (required).
  url: <string>
  # HTTP method used to access the data source (required).
  http_method: get | post | put | patch | delete
  # Payload type (optional).
  payload_type: application/json | application/xml | text/plain | text/xml | application/x-www-form-urlencoded
  # Allow insecure (e.g. when using HTTPS with untrusted cert) access to
  # this data source. (optional).
  insecure: true | false
  # List of response codes which are considered valid. (optional).
  valid_response_codes: <string>
  # List of authorizations required to access the data source (optional).
  authorization:
    - <string>
  # Proxy to use to access the data source (optional).
  proxy: <string>
  # Ambassador to use to access the data source (optional).
  ambassador: <string>
  # Cache connection to use for caching responses from the data source
  # (optional).
  cache: <string>
  # The TTL (time to live) for cached responses (optional).
  cache_ttl: <integer>
  # References the schema through which the data source was created
  # (optional).
  schema: <string>
  # Schema describing the expected parameters for this data source
  # (optional).
  parameters:
    - # Schema: ds_param_attr
      # Field name (required).
      name: <string>
      # Type for this field (optional).
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
      # Nested fields, in case type is object (optional).
      properties:
        - <ds_param_attr> # see schema defintion above
      # Sample data (optional).
      sample: <any>
  # Schema describing the format of the response of this data source
  # (optional).
  attributes:
    - # Schema: ds_param_attr
      # Field name (required).
      name: <string>
      # Type for this field (optional).
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
      # Nested fields, in case type is object (optional).
      properties:
        - <ds_param_attr> # see schema defintion above
      # Sample data (optional).
      sample: <any>

DataSource/REST (v2)

Definition details

kind: DataSource/REST
version: v2
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # URL for accessing the data source (required).
  url: <string>
  # HTTP method used to access the data source (required).
  http_method: get | post | put | patch | delete
  # Payload type (optional).
  payload_type: application/json | application/xml | text/plain | text/xml | application/x-www-form-urlencoded
  # Allow insecure (e.g. when using HTTPS with untrusted cert) access to
  # this data source. (optional).
  insecure: true | false
  # List of response codes which are considered valid. (optional).
  valid_response_codes: <string>
  # List of authorizations required to access the data source (optional).
  authorization:
    - <string>
  # Proxy to use to access the data source (optional).
  proxy: <string>
  # Ambassador to use to access the data source (optional).
  ambassador: <string>
  # Cache connection to use for caching responses from the data source
  # (optional).
  cache: <string>
  # The TTL (time to live) for cached responses (optional).
  cache_ttl: <integer>
  # References the schema through which the data source was created
  # (optional).
  schema: <string>
  # Schema describing the expected parameters for this data source
  # (optional).
  parameter_schema: # Schema: json_schema
  # Data sample for the expected parameters (optional).
  parameter_sample: <object>
  # Schema describing the format of the response of this data source
  # (optional).
  attribute_schema: # Schema: json_schema
  # Data sample for the response (optional).
  attribute_sample: <object>

DataSource/SOAP (v1)

Definition details

kind: DataSource/SOAP
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # URL for accessing the data source (required).
  url: <string>
  # SOAP method name (optional).
  method_name: <string>
  # SOAP version (optional).
  soap_version: 1.1 | 1.2
  # SOAP input XML template (required).
  soap_input_xml: <string>
  # SOAP output XML template (required).
  soap_output_xml: <string>
  # SOAP fault XML template (optional).
  soap_fault_xml: <string>
  # Payload type (optional).
  payload_type: application/json | application/xml | text/plain | text/xml | application/x-www-form-urlencoded
  # Allow insecure (e.g. when using HTTPS with untrusted cert) access to
  # this data source. (optional).
  insecure: true | false
  # List of response codes which are considered valid. (optional).
  valid_response_codes: <string>
  # List of authorizations required to access the data source (optional).
  authorization:
    - <string>
  # Proxy to use to access the data source (optional).
  proxy: <string>
  # Ambassador to use to access the data source (optional).
  ambassador: <string>
  # Cache connection to use for caching responses from the data source
  # (optional).
  cache: <string>
  # The TTL (time to live) for cached responses (optional).
  cache_ttl: <integer>
  # References the schema through which the data source was created
  # (optional).
  schema: <string>
  # Schema describing the expected parameters for this data source
  # (optional).
  parameters:
    - # Schema: ds_param_attr
      # Field name (required).
      name: <string>
      # Type for this field (optional).
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
      # Nested fields, in case type is object (optional).
      properties:
        - <ds_param_attr> # see schema defintion above
      # Sample data (optional).
      sample: <any>
  # Schema describing the format of the response of this data source
  # (optional).
  attributes:
    - # Schema: ds_param_attr
      # Field name (required).
      name: <string>
      # Type for this field (optional).
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
      # Nested fields, in case type is object (optional).
      properties:
        - <ds_param_attr> # see schema defintion above
      # Sample data (optional).
      sample: <any>

DataSource/SOAP (v2)

Definition details

kind: DataSource/SOAP
version: v2
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # URL for accessing the data source (required).
  url: <string>
  # SOAP method name (optional).
  method_name: <string>
  # SOAP version (optional).
  soap_version: 1.1 | 1.2
  # SOAP input XML template (required).
  soap_input_xml: <string>
  # SOAP output XML template (required).
  soap_output_xml: <string>
  # SOAP fault XML template (optional).
  soap_fault_xml: <string>
  # Payload type (optional).
  payload_type: application/json | application/xml | text/plain | text/xml | application/x-www-form-urlencoded
  # Allow insecure (e.g. when using HTTPS with untrusted cert) access to
  # this data source. (optional).
  insecure: true | false
  # List of response codes which are considered valid. (optional).
  valid_response_codes: <string>
  # List of authorizations required to access the data source (optional).
  authorization:
    - <string>
  # Proxy to use to access the data source (optional).
  proxy: <string>
  # Ambassador to use to access the data source (optional).
  ambassador: <string>
  # Cache connection to use for caching responses from the data source
  # (optional).
  cache: <string>
  # The TTL (time to live) for cached responses (optional).
  cache_ttl: <integer>
  # References the schema through which the data source was created
  # (optional).
  schema: <string>
  # Schema describing the expected parameters for this data source
  # (optional).
  parameter_schema: # Schema: json_schema
  # Data sample for the expected parameters (optional).
  parameter_sample: <object>
  # Schema describing the format of the response of this data source
  # (optional).
  attribute_schema: # Schema: json_schema
  # Data sample for the response (optional).
  attribute_sample: <object>

Endpoint/REST (v1)

Definition details

kind: Endpoint/REST
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Path used to access this endpoint (required).
  path: <string>
  # HTTP method to access this endpoint (required).
  http_method: get | post | put | patch | delete
  # Global Rate Limits (optional).
  global_rate_limits:
    - # Schema: rate_limit
      # Duration of the rate limit window in seconds (required).
      seconds: <integer>
      # Number of allowed requests in given time window (required).
      requests: <integer>
  # Pipeline to run for this endpoint (optional).
  pipeline: # Schema: embedded_pipeline
    # units for this pipeline (required).
    units:
      - # Schema: document

Endpoint/SOAP (v1)

Definition details

kind: Endpoint/SOAP
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Path used to access this endpoint (required).
  path: <string>
  # SOAP method name (required).
  method_name: <string>
  # SOAP action (required).
  soap_action: <string>
  # SOAP version (required).
  soap_version: <string>
  # SOAP input XML template (required).
  soap_input_xml: <string>
  # SOAP output XML template (required).
  soap_output_xml: <string>
  # SOAP fault XML template (required).
  soap_fault_xml: <string>
  # Global Rate Limits (optional).
  global_rate_limits:
    - # Schema: rate_limit
      # Duration of the rate limit window in seconds (required).
      seconds: <integer>
      # Number of allowed requests in given time window (required).
      requests: <integer>
  # Pipeline to run for this endpoint (optional).
  pipeline: # Schema: embedded_pipeline
    # units for this pipeline (required).
    units:
      - # Schema: document

EndpointGroup/SOAP (v1)

Definition details

kind: EndpointGroup/SOAP
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Path (optional).
  path: <string>
  # Original Wsdl (optional).
  original_wsdl: <string>
  # Wsdl (optional).
  wsdl: <string>

Pipeline (v1)

Definition details

kind: Pipeline
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Units (required).
  units:
    - # Schema: document

Project (v1)

Definition details

kind: Project
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Uuid (optional).
  uuid: <string>
  # Description (optional).
  description: <string>

Proxy (v1)

Definition details

kind: Proxy
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Url (optional).
  url: <string>
  # Username (optional).
  username: <string>
  # Password (optional).
  password: <string>

Scheduler (v1)

Definition details

kind: Scheduler
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Interval (required).
  interval: <integer>
  # Starting Point (required).
  starting_point: <integer>
  # Pipeline to run for this endpoint (optional).
  pipeline: # Schema: embedded_pipeline
    # units for this pipeline (required).
    units:
      - # Schema: document

Schema (v1)

Definition details

kind: Schema
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Identifier used to match with a schema file, so future uploads update
  # existing data sources (required).
  identifier: <string>
  # Importer identifies the importer used for this schema. For OpenAPI
  # 2.0: openapi-2.0; SOAP: paos-soap (required).
  importer: <string>
  # Original schema is used to store the uploaded schema (optional).
  original_schema: <string>

Service (v1)

Definition details

kind: Service
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Caption used in the UI to quickly explain the service (optional).
  caption: <string>
  # Longer description used in the UI about the service details
  # (optional).
  description: <string>
  # List of the service actions; a service can provide multiple actions
  # that can be performed on it, for instance providing the usual CRUD
  # operations on data stored by the service (optional).
  actions:
    - # Schema: service_action
      # Service action name (required).
      name: <string>
      # Service Pipeline (required).
      pipeline: # Schema: embedded_pipeline
        # units for this pipeline (required).
        units:
          - # Schema: document
  # Schema describing the parameters for a ServiceInstall (optional).
  parameter_schema: # Schema: json_schema

ServiceInstall (v1)

Definition details

kind: ServiceInstall
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Service (required).
  service: <string>
  # Parameters (optional).
  parameters:
    - # Schema: service_params_ref
      # Reference into schema to define how the value/credential is passed to
      # service (required).
      ref: <string>
      # Retrieve parameter value from a credential (optional).
      credential: <string>
      # Plain text value (optional).
      value: <string>

Stream/EventHub (v1)

Definition details

kind: Stream/EventHub
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Event Hub Name (required).
  event_hub_name: <string>
  # Consumer Group Name (required).
  consumer_group_name: <string>
  # Stream Group (required).
  stream_group: <string>
  # Pipeline to run for this endpoint (optional).
  pipeline: # Schema: embedded_pipeline
    # units for this pipeline (required).
    units:
      - # Schema: document

Stream/Kafka (v1)

Definition details

kind: Stream/Kafka
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # The topic from which events should be consumed (required).
  topic: <string>
  # The consumer group to use for consuming events; see
  # https://kafka.apache.org/intro#intro_consumers for details (required).
  consumer_group_name: <string>
  # The initial position indicates for new consumer groups from which
  # position to start reading events (optional).
  initial_position: earliest | latest
  # Stream Group (required).
  stream_group: <string>
  # Pipeline to run for this endpoint (optional).
  pipeline: # Schema: embedded_pipeline
    # units for this pipeline (required).
    units:
      - # Schema: document

StreamGroup/EventHub (v1)

Definition details

kind: StreamGroup/EventHub
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Connection String (required).
  connection_string: <string>
  # Partitions (required).
  partitions: <string>
  # Storage Connection String (optional).
  storage_connection_string: <string>
  # Storage Container Name (optional).
  storage_container_name: <string>

StreamGroup/Kafka (v1)

Definition details

kind: StreamGroup/Kafka
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Servers (required).
  servers:
    - <string>

StreamProcessor (v1)

Definition details

kind: StreamProcessor
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Inputs (optional).
  inputs:
    - # Schema: stream_processor_input
      # Stream input name (required).
      name: <string>
      # Schema defining expected format of input data (optional).
      schema: # Schema: json_schema
      # Sample values illustrating multiple events from input (optional).
      sample:
        - <object>
      # Reference to stream definition (optional).
      stream: <string>
  # Views (optional).
  views:
    - # Schema: stream_processor_view
      # View name (required).
      name: <string>
      # Query which defines the result and schema of this view (required).
      query: <string>
      # Sample values illustrating multiple entries of this view (optional).
      sample:
        - <object>
  # Queries (optional).
  queries:
    - # Schema: stream_processor_query
      # Query name (required).
      name: <string>
      # Query which defines the result and schema (required).
      query: <string>
      # Sample values illustrating multiple results of this query (optional).
      sample:
        - <object>
      # Pipeline used to process each result (optional).
      pipeline: # Schema: embedded_pipeline
        # units for this pipeline (required).
        units:
          - # Schema: document

Unit/DataSource (v1)

Definition details

kind: Unit/DataSource
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Inputs (optional).
  inputs:
    - <string>
  # Data Source (required).
  data_source: <string>
  # Auth (optional).
  auth:
    - # Schema: ds_unit_auth
      # References the scheme on the data source (required).
      scheme: <string>
      # Describes how the scheme is supposed to be connected (required).
      from: custom | credential | request
      # Credential to use for this  (optional).
      credential: <string>
  # Parameters (optional).
  parameters:
    - # Schema: unit_param
      # Field name (required).
      name: <string>
      # Type for this field (optional).
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
      # Nested fields, in case type is object (optional).
      properties:
        - <unit_param> # see schema defintion above
      # Formula used to compute the value for this field (optional).
      formula: <string>
      # Sample data (optional).
      sample: <any>
      # Sample data (YAML format) (optional).
      sample_yaml: <string>

Unit/DataSource (v2)

Definition details

kind: Unit/DataSource
version: v2
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Inputs (optional).
  inputs:
    - <string>
  # Data Source (required).
  data_source: <string>
  # Auth (optional).
  auth:
    - # Schema: ds_unit_auth
      # References the scheme on the data source (required).
      scheme: <string>
      # Describes how the scheme is supposed to be connected (required).
      from: custom | credential | request
      # Credential to use for this  (optional).
      credential: <string>
  # Formulas (optional).
  formulas:
    - # Schema: formula_ref
      # Reference into schema to define how the result of the formula is used
      # to create full result (required).
      ref: <string>
      # Formula to compute value for the referenced position in the schema
      # (required).
      formula: <string>
  # Data sample for the expected parameters (optional).
  parameter_sample: <object>

Unit/Decision (v1)

Definition details

kind: Unit/Decision
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Inputs (optional).
  inputs:
    - <string>
  # Branches (optional).
  branches:
    - # Schema: decision_unit_branch
      # Branche name (required).
      name: <string>
      # Formula used to compute if the branch should be executed or not
      # (required).
      formula: <string>

Unit/Endpoint (v1)

Definition details

kind: Unit/Endpoint
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Inputs (optional).
  inputs:
    - <string>
  # Parameters (optional).
  parameters:
    - # Schema: unit_param
      # Field name (required).
      name: <string>
      # Type for this field (optional).
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
      # Nested fields, in case type is object (optional).
      properties:
        - <unit_param> # see schema defintion above
      # Formula used to compute the value for this field (optional).
      formula: <string>
      # Sample data (optional).
      sample: <any>
      # Sample data (YAML format) (optional).
      sample_yaml: <string>

Unit/Endpoint (v2)

Definition details

kind: Unit/Endpoint
version: v2
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Inputs (optional).
  inputs:
    - <string>
  # Schema describing the expected parameters for this pipeline unit
  # (optional).
  parameter_schema: # Schema: json_schema
  # Data sample for the expected parameters (optional).
  parameter_sample: <object>
  # Formulas (optional).
  formulas:
    - # Schema: formula_ref
      # Reference into schema to define how the result of the formula is used
      # to create full result (required).
      ref: <string>
      # Formula to compute value for the referenced position in the schema
      # (required).
      formula: <string>

Unit/Entry (v1)

Definition details

kind: Unit/Entry
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Parameters (optional).
  parameters:
    - # Schema: unit_param
      # Field name (required).
      name: <string>
      # Type for this field (optional).
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
      # Nested fields, in case type is object (optional).
      properties:
        - <unit_param> # see schema defintion above
      # Formula used to compute the value for this field (optional).
      formula: <string>
      # Sample data (optional).
      sample: <any>
      # Sample data (YAML format) (optional).
      sample_yaml: <string>

Unit/Entry (v2)

Definition details

kind: Unit/Entry
version: v2
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Schema describing the expected parameters for this pipeline unit
  # (optional).
  parameter_schema: # Schema: json_schema
  # Data sample for the expected parameters (optional).
  parameter_sample: <object>

Unit/Event (v1)

Definition details

kind: Unit/Event
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Parameters (optional).
  parameters:
    - # Schema: unit_param
      # Field name (required).
      name: <string>
      # Type for this field (optional).
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
      # Nested fields, in case type is object (optional).
      properties:
        - <unit_param> # see schema defintion above
      # Formula used to compute the value for this field (optional).
      formula: <string>
      # Sample data (optional).
      sample: <any>
      # Sample data (YAML format) (optional).
      sample_yaml: <string>

Unit/Event (v2)

Definition details

kind: Unit/Event
version: v2
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Schema describing the expected parameters for this pipeline unit
  # (optional).
  parameter_schema: # Schema: json_schema
  # Data sample for the expected parameters (optional).
  parameter_sample: <object>

Unit/Map (v1)

Definition details

kind: Unit/Map
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Inputs (optional).
  inputs:
    - <string>
  # Parameters (optional).
  parameters:
    - # Schema: unit_param
      # Field name (required).
      name: <string>
      # Type for this field (optional).
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
      # Nested fields, in case type is object (optional).
      properties:
        - <unit_param> # see schema defintion above
      # Formula used to compute the value for this field (optional).
      formula: <string>
      # Sample data (optional).
      sample: <any>
      # Sample data (YAML format) (optional).
      sample_yaml: <string>
  # Item Pipeline (optional).
  item_pipeline: # Schema: embedded_pipeline
    # units for this pipeline (required).
    units:
      - # Schema: document

Unit/Map (v2)

Definition details

kind: Unit/Map
version: v2
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Inputs (optional).
  inputs:
    - <string>
  # Schema describing the expected parameters for this pipeline unit
  # (optional).
  parameter_schema: # Schema: json_schema
  # Data sample for the expected parameters (optional).
  parameter_sample: <object>
  # Formulas (optional).
  formulas:
    - # Schema: formula_ref
      # Reference into schema to define how the result of the formula is used
      # to create full result (required).
      ref: <string>
      # Formula to compute value for the referenced position in the schema
      # (required).
      formula: <string>
  # Item Pipeline (optional).
  item_pipeline: # Schema: embedded_pipeline
    # units for this pipeline (required).
    units:
      - # Schema: document

Unit/Merge (v1)

Definition details

kind: Unit/Merge
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Inputs (optional).
  inputs:
    - <string>

Unit/Request (v1)

Definition details

kind: Unit/Request
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Parameters (optional).
  parameters:
    - # Schema: unit_param
      # Field name (required).
      name: <string>
      # Type for this field (optional).
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
      # Nested fields, in case type is object (optional).
      properties:
        - <unit_param> # see schema defintion above
      # Formula used to compute the value for this field (optional).
      formula: <string>
      # Sample data (optional).
      sample: <any>
      # Sample data (YAML format) (optional).
      sample_yaml: <string>
  # Check Pipelines (optional).
  check_pipelines:
    - <string>

Unit/Request (v2)

Definition details

kind: Unit/Request
version: v2
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Schema describing the expected parameters for this pipeline unit
  # (optional).
  parameter_schema: # Schema: json_schema
  # Data sample for the expected parameters (optional).
  parameter_sample: <object>
  # Check Pipelines (optional).
  check_pipelines:
    - <string>

Unit/Result (v1)

Definition details

kind: Unit/Result
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Inputs (optional).
  inputs:
    - <string>
  # Parameters (optional).
  parameters:
    - # Schema: unit_param
      # Field name (required).
      name: <string>
      # Type for this field (optional).
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
      # Nested fields, in case type is object (optional).
      properties:
        - <unit_param> # see schema defintion above
      # Formula used to compute the value for this field (optional).
      formula: <string>
      # Sample data (optional).
      sample: <any>
      # Sample data (YAML format) (optional).
      sample_yaml: <string>

Unit/Result (v2)

Definition details

kind: Unit/Result
version: v2
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Inputs (optional).
  inputs:
    - <string>
  # Schema describing the expected parameters for this pipeline unit
  # (optional).
  parameter_schema: # Schema: json_schema
  # Data sample for the expected parameters (optional).
  parameter_sample: <object>
  # Formulas (optional).
  formulas:
    - # Schema: formula_ref
      # Reference into schema to define how the result of the formula is used
      # to create full result (required).
      ref: <string>
      # Formula to compute value for the referenced position in the schema
      # (required).
      formula: <string>

Unit/SchedulerEntry (v1)

Definition details

kind: Unit/SchedulerEntry
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>

Unit/SecureStore (v1)

Definition details

kind: Unit/SecureStore
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Credentials (optional).
  credentials:
    - <string>

Unit/Service (v2)

Definition details

kind: Unit/Service
version: v2
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Inputs (optional).
  inputs:
    - <string>
  # Service Action to invoke (required).
  service_action: <string>
  # Formulas (optional).
  formulas:
    - # Schema: formula_ref
      # Reference into schema to define how the result of the formula is used
      # to create full result (required).
      ref: <string>
      # Formula to compute value for the referenced position in the schema
      # (required).
      formula: <string>

Unit/Sink (v1)

Definition details

kind: Unit/Sink
version: v1
metadata:
  # Uniquely identifies a resource (required).
  id: <string>
  # Project this resource belongs to (optional).
  project: <string>
  # Pipeline (optional).
  pipeline: <string>
definition:
  # Name used as label for this resource in UIs (required).
  name: <string>
  # Inputs (optional).
  inputs:
    - <string>
  # Parameters (optional).
  parameters:
    - # Schema: unit_param
      # Field name (required).
      name: <string>
      # Type for this field (optional).
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
      # Nested fields, in case type is object (optional).
      properties:
        - <unit_param> # see schema defintion above
      # Formula used to compute the value for this field (optional).
      formula: <string>