Resource Definition

Ambassador (v1)
The Ambassador resource describes a Xapix Ambassador used for easy network traversal.
Definition details
1
kind: Ambassador
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # The Ambassador's UUID (required).
12
  uuid: <string>
Copied!
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
1
kind: ApiPublishing
2
version: v1
3
metadata:
4
  # The ID has to be same as project id for ApiPublishing (optional).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # API publishing enabled? (required).
10
  enabled: true | false
11
  # Enables sending CORS headers for all endpoints (optional).
12
  cors_enabled: true | false
13
  # List of allowed origins for the Access-Control-Allow-Origin header
14
  # (optional).
15
  cors_origins:
16
    - <string>
17
  # User management component; if set to custom, use your custom
18
  # check-pipelines to extract user details from the request (required).
19
  user_management: shisa | custom
20
  # Store used for rate limiting data; supported types:
21
  # CacheConnection/Redis (optional).
22
  rate_limit_store: <string>
23
  # Key pair for generating/validating JWTs; used by the Xapix user
24
  # management component (shisa); supported types:
25
  # Credential/PublicPrivateKey (optional).
26
  jwt_credential: <string>
Copied!
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
1
kind: ApiPublishingRole
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Type of role (required).
12
  type: custom_access | no_access | all_access
13
  # Rate limits for users with this role (optional).
14
  rate_limits:
15
    - # Schema: rate_limit
16
      # Duration of the rate limit window in seconds (required).
17
      seconds: <integer>
18
      # Number of allowed requests in given time window (required).
19
      requests: <integer>
20
  # List of accessible endpoints (for custom_access type) (optional).
21
  endpoints:
22
    - <string>
Copied!
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
1
kind: AuthScheme/Aws
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Name of AWS service (required).
12
  service: <string>
13
  # Name of AWS region (required).
14
  region: <string>
Copied!
AuthScheme/AwsAccessKey (v1)
The AuthScheme/AwsAccessKey resource describes an authentication scheme using AWS Identity and Access Management. See https://docs.xapix.io/resources/authentication for more details.
Definition details
1
kind: AuthScheme/AwsAccessKey
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Type: basic, basic-with-role or local (required).
12
  key_type: basic | basic-with-role | local
13
  # Role Amazon Resource Name (ARN) (optional).
14
  role_arn: <string>
Copied!
AuthScheme/AzureConnectionString (v1)
The AuthScheme/AzureConnectionString resource describes an authentication scheme using Azure Connection String. See https://docs.xapix.io/resources/authentication for more details.
Definition details
1
kind: AuthScheme/AzureConnectionString
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Required keys for the Azure Connection String Credential (optional).
12
  required_keys: <array>
Copied!
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
1
kind: AuthScheme/BasicAuth
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
Copied!
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
1
kind: AuthScheme/BearerToken
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
Copied!
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
1
kind: AuthScheme/Cookie
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Name of the cookie expected to be used to hold the credential
12
  # (required).
13
  cookie: <string>
Copied!
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
1
kind: AuthScheme/OAuth2
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # URL to the OAuth2 token endpoint (required).
12
  url: <string>
13
  # Grant type to use when fetching an oauth2 access token (required).
14
  grant_type: client_credentials | password | refresh_token
15
  # Client ID to use for password and refresh_token grant types
16
  # (optional).
17
  client_id: <string>
18
  # Requested scope for the oauth2 access token (optional).
19
  scope: <string>
Copied!
AuthScheme/SaslPlain (v1)
The AuthScheme/SaslPlain resource describes an authentication scheme using the Simple Authentication and Security Layer framework. See https://docs.xapix.io/resources/authentication for more details.
Definition details
1
kind: AuthScheme/SaslPlain
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
Copied!
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
1
kind: AuthScheme/Token
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # The parameter expected to be used to hold the credential (required).
12
  parameter: # Schema: auth_scheme_param
13
    # Parameter name (required).
14
    name: <string>
15
    # Parameter type (required).
16
    type: header | query
Copied!
CacheConnection/Memcached (v1)
Definition details
1
kind: CacheConnection/Memcached
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Ambassador (optional).
12
  ambassador: <string>
13
  # Hostnames (optional).
14
  hostnames:
15
    - <string>
Copied!
CacheConnection/Redis (v1)
Definition details
1
kind: CacheConnection/Redis
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Ambassador (optional).
12
  ambassador: <string>
13
  # Uri (optional).
14
  uri: <string>
Copied!
Credential/AzureConnectionString (v1)
Definition details
1
kind: Credential/AzureConnectionString
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Connection String (required).
12
  connection_string: <string>
Copied!
Credential/PublicPrivateKey (v1)
Definition details
1
kind: Credential/PublicPrivateKey
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Public Key (optional).
12
  public_key: <string>
13
  # Private Key (optional).
14
  private_key: <string>
Copied!
Credential/Token (v1)
Definition details
1
kind: Credential/Token
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Token (optional).
12
  token: <string>
Copied!
Credential/UserPassword (v1)
Definition details
1
kind: Credential/UserPassword
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Username (optional).
12
  username: <string>
13
  # Password (optional).
14
  password: <string>
Copied!
DataSource/EventHubProducer (v2)
Definition details
1
kind: DataSource/EventHubProducer
2
version: v2
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Azure Event Hub Name (required).
12
  event_hub_name: <string>
13
  # Ambassador to use for this event producer (optional).
14
  ambassador: <string>
15
  # List of authorizations required to access the producer (optional).
16
  authorization:
17
    - <string>
18
  # Schema describing the expected parameters for this data source
19
  # (optional).
20
  parameter_schema: # Schema: json_schema
21
  # Data sample for the expected parameters (optional).
22
  parameter_sample: <object>
Copied!
DataSource/ExternalExecutor (v1)
Definition details
1
kind: DataSource/ExternalExecutor
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # External Executor Name (required).
12
  executor_name: <string>
13
  # External Executor Token (optional).
14
  executor_token: <string>
15
  # Schema describing the expected parameters for this data source
16
  # (optional).
17
  parameters:
18
    - # Schema: ds_param_attr
19
      # Field name (required).
20
      name: <string>
21
      # Type for this field (optional).
22
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
23
      # Nested fields, in case type is object (optional).
24
      properties:
25
        - <ds_param_attr> # see schema defintion above
26
      # Sample data (optional).
27
      sample: <any>
28
  # Schema describing the format of the response of this data source
29
  # (optional).
30
  attributes:
31
    - # Schema: ds_param_attr
32
      # Field name (required).
33
      name: <string>
34
      # Type for this field (optional).
35
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
36
      # Nested fields, in case type is object (optional).
37
      properties:
38
        - <ds_param_attr> # see schema defintion above
39
      # Sample data (optional).
40
      sample: <any>
Copied!
DataSource/ExternalExecutor (v2)
Definition details
1
kind: DataSource/ExternalExecutor
2
version: v2
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # External Executor Name (required).
12
  executor_name: <string>
13
  # External Executor Token (optional).
14
  executor_token: <string>
15
  # Schema describing the expected parameters for this data source
16
  # (optional).
17
  parameter_schema: # Schema: json_schema
18
  # Data sample for the expected parameters (optional).
19
  parameter_sample: <object>
20
  # Schema describing the format of the response of this data source
21
  # (optional).
22
  attribute_schema: # Schema: json_schema
23
  # Data sample for the response (optional).
24
  attribute_sample: <object>
Copied!
DataSource/KafkaProducer (v2)
Definition details
1
kind: DataSource/KafkaProducer
2
version: v2
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Apache Kafka Topic (required).
12
  topic: <string>
13
  # Apache Kafka Transport (required).
14
  transport: <string>
15
  # Apache Kafka Bootstrap Servers (required).
16
  bootstrap_servers: <string>
17
  # Ambassador to use for this event producer (optional).
18
  ambassador: <string>
19
  # List of authorizations required to access the producer (optional).
20
  authorization:
21
    - <string>
22
  # Schema describing the expected parameters for this data source
23
  # (optional).
24
  parameter_schema: # Schema: json_schema
25
  # Data sample for the expected parameters (optional).
26
  parameter_sample: <object>
Copied!
DataSource/KinesisProducer (v2)
Definition details
1
kind: DataSource/KinesisProducer
2
version: v2
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # AWS Kinesis Data Stream Name (required).
12
  stream_name: <string>
13
  # AWS Region (required).
14
  region: <string>
15
  # AWS Kinesis Data Stream Endpoint (optional).
16
  endpoint_url: <string>
17
  # Ambassador to use for this event producer (optional).
18
  ambassador: <string>
19
  # List of authorizations required to access the producer (optional).
20
  authorization:
21
    - <string>
22
  # Schema describing the expected parameters for this data source
23
  # (optional).
24
  parameter_schema: # Schema: json_schema
25
  # Data sample for the expected parameters (optional).
26
  parameter_sample: <object>
Copied!
DataSource/REST (v1)
Definition details
1
kind: DataSource/REST
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # URL for accessing the data source (required).
12
  url: <string>
13
  # HTTP method used to access the data source (required).
14
  http_method: get | post | put | patch | delete
15
  # Payload type (optional).
16
  payload_type: application/json | application/x-www-form-urlencoded | application/xml | text/plain | text/xml
17
  # Allow insecure (e.g. when using HTTPS with untrusted cert) access to
18
  # this data source. (optional).
19
  insecure: true | false
20
  # List of response codes which are considered valid. (optional).
21
  valid_response_codes: <string>
22
  # List of authorizations required to access the data source (optional).
23
  authorization:
24
    - <string>
25
  # Proxy to use to access the data source (optional).
26
  proxy: <string>
27
  # Ambassador to use to access the data source (optional).
28
  ambassador: <string>
29
  # Cache connection to use for caching responses from the data source
30
  # (optional).
31
  cache: <string>
32
  # The TTL (time to live) for cached responses (optional).
33
  cache_ttl: <integer>
34
  # References the schema through which the data source was created
35
  # (optional).
36
  schema: <string>
37
  # Schema describing the expected parameters for this data source
38
  # (optional).
39
  parameters:
40
    - # Schema: ds_param_attr
41
      # Field name (required).
42
      name: <string>
43
      # Type for this field (optional).
44
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
45
      # Nested fields, in case type is object (optional).
46
      properties:
47
        - <ds_param_attr> # see schema defintion above
48
      # Sample data (optional).
49
      sample: <any>
50
  # Schema describing the format of the response of this data source
51
  # (optional).
52
  attributes:
53
    - # Schema: ds_param_attr
54
      # Field name (required).
55
      name: <string>
56
      # Type for this field (optional).
57
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
58
      # Nested fields, in case type is object (optional).
59
      properties:
60
        - <ds_param_attr> # see schema defintion above
61
      # Sample data (optional).
62
      sample: <any>
Copied!
DataSource/REST (v2)
Definition details
1
kind: DataSource/REST
2
version: v2
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # URL for accessing the data source (required).
12
  url: <string>
13
  # HTTP method used to access the data source (required).
14
  http_method: get | post | put | patch | delete
15
  # Payload type (optional).
16
  payload_type: application/json | application/x-www-form-urlencoded | application/xml | text/plain | text/xml
17
  # Allow insecure (e.g. when using HTTPS with untrusted cert) access to
18
  # this data source. (optional).
19
  insecure: true | false
20
  # List of response codes which are considered valid. (optional).
21
  valid_response_codes: <string>
22
  # List of authorizations required to access the data source (optional).
23
  authorization:
24
    - <string>
25
  # Proxy to use to access the data source (optional).
26
  proxy: <string>
27
  # Ambassador to use to access the data source (optional).
28
  ambassador: <string>
29
  # Cache connection to use for caching responses from the data source
30
  # (optional).
31
  cache: <string>
32
  # The TTL (time to live) for cached responses (optional).
33
  cache_ttl: <integer>
34
  # References the schema through which the data source was created
35
  # (optional).
36
  schema: <string>
37
  # Schema describing the expected parameters for this data source
38
  # (optional).
39
  parameter_schema: # Schema: json_schema
40
  # Data sample for the expected parameters (optional).
41
  parameter_sample: <object>
42
  # Schema describing the format of the response of this data source
43
  # (optional).
44
  attribute_schema: # Schema: json_schema
45
  # Data sample for the response (optional).
46
  attribute_sample: <object>
Copied!
DataSource/SOAP (v1)
Definition details
1
kind: DataSource/SOAP
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # URL for accessing the data source (required).
12
  url: <string>
13
  # SOAP method name (optional).
14
  method_name: <string>
15
  # SOAP version (optional).
16
  soap_version: 1.1 | 1.2
17
  # SOAP input XML template (required).
18
  soap_input_xml: <string>
19
  # SOAP output XML template (required).
20
  soap_output_xml: <string>
21
  # SOAP fault XML template (optional).
22
  soap_fault_xml: <string>
23
  # Payload type (optional).
24
  payload_type: application/json | application/x-www-form-urlencoded | application/xml | text/plain | text/xml
25
  # Allow insecure (e.g. when using HTTPS with untrusted cert) access to
26
  # this data source. (optional).
27
  insecure: true | false
28
  # List of response codes which are considered valid. (optional).
29
  valid_response_codes: <string>
30
  # List of authorizations required to access the data source (optional).
31
  authorization:
32
    - <string>
33
  # Proxy to use to access the data source (optional).
34
  proxy: <string>
35
  # Ambassador to use to access the data source (optional).
36
  ambassador: <string>
37
  # Cache connection to use for caching responses from the data source
38
  # (optional).
39
  cache: <string>
40
  # The TTL (time to live) for cached responses (optional).
41
  cache_ttl: <integer>
42
  # References the schema through which the data source was created
43
  # (optional).
44
  schema: <string>
45
  # Schema describing the expected parameters for this data source
46
  # (optional).
47
  parameters:
48
    - # Schema: ds_param_attr
49
      # Field name (required).
50
      name: <string>
51
      # Type for this field (optional).
52
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
53
      # Nested fields, in case type is object (optional).
54
      properties:
55
        - <ds_param_attr> # see schema defintion above
56
      # Sample data (optional).
57
      sample: <any>
58
  # Schema describing the format of the response of this data source
59
  # (optional).
60
  attributes:
61
    - # Schema: ds_param_attr
62
      # Field name (required).
63
      name: <string>
64
      # Type for this field (optional).
65
      type: object | object[] | string | string[] | boolean | boolean[] | integer | integer[] | float | float[] | array | pass_through
66
      # Nested fields, in case type is object (optional).
67
      properties:
68
        - <ds_param_attr> # see schema defintion above
69
      # Sample data (optional).
70
      sample: <any>
Copied!
DataSource/SOAP (v2)
Definition details
1
kind: DataSource/SOAP
2
version: v2
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # URL for accessing the data source (required).
12
  url: <string>
13
  # SOAP method name (optional).
14
  method_name: <string>
15
  # SOAP version (optional).
16
  soap_version: 1.1 | 1.2
17
  # SOAP input XML template (required).
18
  soap_input_xml: <string>
19
  # SOAP output XML template (required).
20
  soap_output_xml: <string>
21
  # SOAP fault XML template (optional).
22
  soap_fault_xml: <string>
23
  # Payload type (optional).
24
  payload_type: application/json | application/x-www-form-urlencoded | application/xml | text/plain | text/xml
25
  # Allow insecure (e.g. when using HTTPS with untrusted cert) access to
26
  # this data source. (optional).
27
  insecure: true | false
28
  # List of response codes which are considered valid. (optional).
29
  valid_response_codes: <string>
30
  # List of authorizations required to access the data source (optional).
31
  authorization:
32
    - <string>
33
  # Proxy to use to access the data source (optional).
34
  proxy: <string>
35
  # Ambassador to use to access the data source (optional).
36
  ambassador: <string>
37
  # Cache connection to use for caching responses from the data source
38
  # (optional).
39
  cache: <string>
40
  # The TTL (time to live) for cached responses (optional).
41
  cache_ttl: <integer>
42
  # References the schema through which the data source was created
43
  # (optional).
44
  schema: <string>
45
  # Schema describing the expected parameters for this data source
46
  # (optional).
47
  parameter_schema: # Schema: json_schema
48
  # Data sample for the expected parameters (optional).
49
  parameter_sample: <object>
50
  # Schema describing the format of the response of this data source
51
  # (optional).
52
  attribute_schema: # Schema: json_schema
53
  # Data sample for the response (optional).
54
  attribute_sample: <object>
Copied!
Endpoint/REST (v1)
Definition details
1
kind: Endpoint/REST
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Path used to access this endpoint (required).
12
  path: <string>
13
  # HTTP method to access this endpoint (required).
14
  http_method: get | post | put | patch | delete
15
  # Global Rate Limits (optional).
16
  global_rate_limits:
17
    - # Schema: rate_limit
18
      # Duration of the rate limit window in seconds (required).
19
      seconds: <integer>
20
      # Number of allowed requests in given time window (required).
21
      requests: <integer>
22
  # Pipeline to run for this endpoint (optional).
23
  pipeline: # Schema: embedded_pipeline
24
    # units for this pipeline (required).
25
    units:
26
      - # Schema: document
Copied!
Endpoint/SOAP (v1)
Definition details
1
kind: Endpoint/SOAP
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Path used to access this endpoint (required).
12
  path: <string>
13
  # SOAP method name (required).
14
  method_name: <string>
15
  # SOAP action (required).
16
  soap_action: <string>
17
  # SOAP version (required).
18
  soap_version: <string>
19
  # SOAP input XML template (required).
20
  soap_input_xml: <string>
21
  # SOAP output XML template (required).
22
  soap_output_xml: <string>
23
  # SOAP fault XML template (required).
24
  soap_fault_xml: <string>
25
  # Global Rate Limits (optional).
26
  global_rate_limits:
27
    - # Schema: rate_limit
28
      # Duration of the rate limit window in seconds (required).
29
      seconds: <integer>
30
      # Number of allowed requests in given time window (required).
31
      requests: <integer>
32
  # Pipeline to run for this endpoint (optional).
33
  pipeline: # Schema: embedded_pipeline
34
    # units for this pipeline (required).
35
    units:
36
      - # Schema: document
Copied!
EndpointGroup/SOAP (v1)
Definition details
1
kind: EndpointGroup/SOAP
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Path (optional).
12
  path: <string>
13
  # Original Wsdl (optional).
14
  original_wsdl: <string>
15
  # Wsdl (optional).
16
  wsdl: <string>
Copied!
Pipeline (v1)
Definition details
1
kind: Pipeline
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Units (required).
10
  units:
11
    - # Schema: document
Copied!
Project (v1)
Definition details
1
kind: Project
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
definition:
7
  # Name used as label for this resource in UIs (required).
8
  name: <string>
9
  # Uuid (optional).
10
  uuid: <string>
11
  # Description (optional).
12
  description: <string>
Copied!
Proxy (v1)
Definition details
1
kind: Proxy
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Proxy URL (required).
12
  url: <string>
13
  # Username (optional).
14
  username: <string>
15
  # Password (optional).
16
  password: <string>
Copied!
Proxy (v2)
Definition details
1
kind: Proxy
2
version: v2
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Proxy URL (required).
12
  url: <string>
13
  # Credentials required to access the proxy; supported types:
14
  # Credential/UserPassword (optional).
15
  auth_credential: <string>
Copied!
Scheduler (v1)
Definition details
1
kind: Scheduler
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Interval (required).
12
  interval: <integer>
13
  # Starting Point (required).
14
  starting_point: <integer>
15
  # Pipeline to run for this endpoint (optional).
16
  pipeline: # Schema: embedded_pipeline
17
    # units for this pipeline (required).
18
    units:
19
      - # Schema: document
Copied!
Schema (v1)
Definition details
1
kind: Schema
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Identifier used to match with a schema file, so future uploads update
10
  # existing data sources (required).
11
  identifier: <string>
12
  # Importer identifies the importer used for this schema. For OpenAPI
13
  # 2.0: openapi-2.0; SOAP: paos-soap (required).
14
  importer: <string>
15
  # Original schema is used to store the uploaded schema (optional).
16
  original_schema: <string>
Copied!
Service (v1)
Definition details
1
kind: Service
2
version: v1
3
metadata:
4
  # Uniquely identifies a resource (required).
5
  id: <string>
6
  # Project this resource belongs to (optional).
7
  project: <string>
8
definition:
9
  # Name used as label for this resource in UIs (required).
10
  name: <string>
11
  # Caption used in the UI to quickly explain the service (optional).
12
  caption: <string>
13
  # Longer description used in the UI about the service details
14
  # (optional).
15
  description: <string>
16
  # Contact email - will also be used to get a service icon via gravatar
17
  # (optional).
18
  contact_email: <string>
19
  # Categories - will be used to filter services (optional).
20
  categories:
21
    - amazon | artificial_intelligence | automotive | crm | currency_conversion | database | documents | finance | google | iot | it_operations | location_data | machine_learning | microsoft | mobility | notifications | oracle | real_estate | sap | weather
22
  # List of the service actions; a service can provide multiple actions
23
  # that can be performed on it, for instance providing the usual CRUD
24
  # operations on data stored by the service (optional).
25
  actions:
26
    - # Schema: service_action
27
      # Service action name (required).
28
      name: <string>
29
      # Schema describing the parameters for this action (optional).
30
      parameter_schema: # Schema: json_schema
31
      # Schema describing the data returned by this action (optional).
32
      result_schema: # Schema: json_schema
33